APIs

Contact API

A contact is a lead or prospect that you are trying to reach out to. You can add contacts to a campaign and then send them emails, LinkedIn messages, or some Twitter actions like follow.


Create Contact

Send an array of contacts to bulk create contacts. If you have more than 100 contacts, you can split them into multiple requests.

Duplicates will automatically be ignored.

curl -X POST https://api.supersend.io/v1/auto/contacts \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json" \
-D '{  \
  "contacts": [ \
    "email": "", \
    "first_name": "", \
    "last_name": "", \
    "phone": "", \
    "tags": [], \
    "linkedin_url": "", \
    "twitter": "", \
  ], \
  "TeamId": "xxx-xxx-xxx", \
  "CampaignId": "xxx-xxx-xxx", \
}'

Get Contacts

limit - number - optional, defaults to 10

offset - number - optional, defaults to 0

search - string - optional

curl -X GET 'https://api.supersend.io/v1/auto/contacts?TeamId=xxx&CampaignId=xxx&search=<string>' \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Get Contact

curl -X GET 'https://api.supersend.io/v1/auto/contact/<ContactId>?TeamId=xxx' \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Update Contact

If you want aparticular contact to use a particular sending email address, you can set its SenderId to the SenderId of the email address you want to use. Otherwise, a random one will be assigned when we send the message.

curl -X PUT https://api.supersend.io/v1/auto/contact/<ContactId> \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json" \
-D '{  \
  "email": "", \
  "first_name": "", \
  "last_name": "", \
  "phone": "", \
  "image": "", \
  "replied": true, \
  "bounced": true, \
  "finished": true, \
  "verified": true, \
  "deleted": true, \
  "company_url": "", \
  "one_liner": "", \
  "linkedin_url": "", \
  "twitter": "", \
  "SenderId": "xxx-xxx-xxx", \
  "TeamId": "xxx-xxx-xxx", \
  "CampaignId": "xxx-xxx-xxx", \
}'

Update Contacts

Bulk update contacts. for example if you put markAll as verified and markAs to true then all leads would be marked as verified.

markAll is one of ["deleted", "failed_email_validation", "verified"] markAs is one of [true, false]

curl -X PUT https://api.supersend.io/v1/auto/contacts \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json" \
-D '{  \
  "markAll": "deleted", \
  "markAs": true, \
  "TeamId": "xxx-xxx-xxx", \
  "CampaignId": "xxx-xxx-xxx", \
}'
Previous
Authentication