Managing Contacts via the Super Send API

Managing Contacts via the Super Send API

The Super Send API allows you to programmatically create, update, and manage contacts, providing a streamlined way to keep your contact lists organized and up-to-date. Here’s how to manage contacts effectively using the API.

1. Creating Contacts

You can create new contacts by making a POST request to the contacts endpoint.

Example Request:

curl -X POST https://api.supersend.io/v1/contacts \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" \
-d '{
  "contacts": [
    {
      "email": "example@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "phone": "123-456-7890",
      "tags": ["lead", "newsletter"],
      "linkedin": "https://www.linkedin.com/in/johndoe",
      "twitter": "@johndoe"
    }
  ],
  "TeamId": "your-team-id",
  "CampaignId": "your-campaign-id"
}'

Required Fields:

email: The contact’s email address (required).
TeamId: The team associated with the contact.
CampaignId: The campaign associated with the contact.

Optional Fields:

first_name, last_name: Contact’s name.
phone: Contact’s phone number.
tags: Tags for categorizing the contact.
linkedin, twitter: Links to the contact’s social profiles.

2. Updating Contacts

To update an existing contact, use the PUT method with the contact’s unique ID.

Example Request:

curl -X PUT https://api.supersend.io/v1/contacts/<CONTACT_ID> \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" \
-d '{
  "first_name": "Jane",
  "tags": ["client"]
}'

Fields You Can Update:

Any field used during creation (e.g., tags, email, phone).

3. Deleting Contacts

To remove a contact, send a DELETE request to the contact’s endpoint with their unique ID.

Example Request:

curl -X DELETE https://api.supersend.io/v1/contacts/<CONTACT_ID> \
-H "Authorization: Bearer <YOUR_API_KEY>"

4. Retrieving Contacts

You can retrieve a list of contacts or details of a specific contact using the GET method.

Retrieve All Contacts:

curl -X GET https://api.supersend.io/v1/contacts \
-H "Authorization: Bearer <YOUR_API_KEY>"

Retrieve a Specific Contact:

curl -X GET https://api.supersend.io/v1/contacts/<CONTACT_ID> \
-H "Authorization: Bearer <YOUR_API_KEY>"

5. Best Practices for Managing Contacts

Keep Data Consistent:
Use standardized tags and formats for fields like phone numbers and names.

Handle Errors Gracefully:
Implement error handling for cases where contacts cannot be created or updated (e.g., duplicate emails).

Regular Updates:
Periodically update contact details to ensure accuracy.

Leverage Tags:
Use tags to segment and organize contacts for targeted campaigns.

By leveraging these API capabilities, you can effectively manage your contact lists, ensuring a seamless and efficient workflow for your outreach efforts.

Updated on: 22/01/2025