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 Contacts

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.

You can also upload CSV from our web application.

curl 'https://api.supersend.io/v1/auto/contacts' \
--header 'Authorization: Bearer <API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
 "contacts": [
    {
        "email": "test@example.com",
        "first_name": "Bob",
        "last_name": "Builder",
        "phone": "111-222-3333",
        "city": "Las Vegas",
        "state": "NV",
        "country": "USA",
        "title: "co-founder",
        "tags": [],
        "linkedin_url": "linkedin URL",
        "twitter": "twitter name",
        "integration_contact_id": "your system's contact id",
        "company_name": "anything",
        "company_url": "company url",
        "custom": {
          "other1": "qwd"
        }
    }
  ],
  "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 (Search value looking inside email, first name, last name, title, company name and integration contact id) linkedin_url - string - Like query on linkedin URL phone - string - Like query on phone twitter - string - Like query on twitter's name city - string - city name state - string - state name country - string - country verified - boolean finished - boolean appointment - boolean bounced - boolean, replied - boolean, unsubscribed - boolean sortBy - string - options are oldest, newest, first_name, first_name_desc, last_name, last_name_desc, company_name, company_name_desc limit - number - how much records you want in one request offset - number - how much records you want to skip before select

All fields are optionals

curl -X POST 'https://api.supersend.io/v1/contacts/all' \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json" \
--data '{
  "TeamId": "xxx-xxx-xxx",
  "CampaignId": "xxx-xxx-xxx",
  "search": "any text",
  "linkedin_url": "http://"
  "phone": "3234",
  "twitter": "",
  "city": "",
  "state": "",
  "country": "",
  "verified": false,
  "finished": false,
  "appointment": false,
  "bounced": false,
  "replied": false,
  "unsubscribed": false,
  "sortBy": "newest",
  "limit": 50,
  "offset": 0
}'

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/contact/<ContactId> \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json" \
-D '{  \
  "email": "", \
  "first_name": "", \
  "last_name": "", \
  "phone": "", \
  "image": "", \
  "title": "", \
  "replied": true, \
  "bounced": true, \
  "appointment": true, \
  "finished": true, \
  "verified": true, \
  "unsubscribed": true, \
  "deleted": false, \
  "company_name": "", \
  "company_url": "", \
  "industry": "", \
  "one_liner": "", \
  "one_liner_2": "", \
  "one_liner_3": "", \
  "selected_one_liner": "", \
  "generateOneLiners": true, \
  "linkedin_url": "", \
  "twitter": "", \
  "next_node": "", \
  "next_step": 0, \
  "interest": "", \
  "city": "", \
  "state": "", \
  "country": "", \
  "custom": {}, \
  "integration_contact_id": "", \
  "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", "restart"]
• markAs is one of [true, false]
• assign is one of [true, false] (This use only to move contacts one campaign to another campaign)

curl -X PUT https://api.supersend.io/v1/auto/contacts \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json" \
-D '{  \
  "markAll": "deleted", \
  "markAs": false, \
  "assign": true, \
  "next_node": "", \
  "ids": ["<ContactId1>", "<ContactId2>"], \
  "TeamId": "xxx-xxx-xxx", \
  "CampaignId": "xxx-xxx-xxx", \
}'