×
    • API authentication required
    Authorize Access
    Need API Access?

    Please use ‘Create Account’ to quickly register and start exploring our APIs

    POST

    https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/contacts

    This is a bulk API, which can create one or more contacts. The contacts created with this API gets added to the Campaigns Addressbook and can only be used in Campaigns. These contacts can be used to create a List using the ‘Campaign – Lists’ APIs.

    Parameter
    Name
    Value
    Description
    * Body
    Jsonbody

    Create a POST body content as provided in API Doc. Each contact can have following parameters:

    number (mandatory), first_name, last_name, company_name, email, tag & custom.

    number (mandatory)- The phone number of the contact that will be called in a campaign. It should be in E.164 format. If not set, our system will try to match it with a country and make a call. If landline number, prefix it with STD code; Ex: 0XXXXXX2400

    first_name (optional) – The first name of the contact

    last_name (optional) – The last name of the contact

    company_name(optional) – The company name of the contact

    email(optional) – The email ID of the contact

    tag(optional) – The tag with which this contact will be associated with

    custom(optional) – Custom field to allow you to pass any number of key value pairs in JSON format

    Response Content Type
  • Try it Now
    • PUT

    https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/contacts/<contactSid>

    While you can update all the parameters of a contact that has not started

    Parameter
    Name
    Value
    Description
    * ID
    path

    contactSid

    * Body
    Jsonbody

    number, first_name, last_name, company_name, email, tag, custom

    Response Content Type
  • Try it Now
    • PUT

    https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/contacts

    This API allows you to update more than one contact at a time.

    Parameter
    Name
    Value
    Description
    * Body
    Jsonbody

    Provide bulk details of sid (mandatory) and the parameters you want to update along with their values.

    Example:

    “sid”: “83ba26b7f11c4e75b4043c8b33ceba49”

    “first_name”: “Rahul”

    parameters can be number, first_name, last_name, company_name, email, tag, custom

    Response Content Type
  • Try it Now
    • GET

    https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/contacts/<contactSid>

    To get the details of a specific contact, make an HTTP GET request

    Parameter
    Name
    Value
    Description
    * id
    path

    contactSid

    Response Content Type
  • Try it Now
    • GET

    https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/contacts?limit=<LIMIT>&offset=<OFFSET>

    This API allows you to fetch details of bulk contacts of an account.

    It supports limit and offset based pagination. Maximum records per page is 20.

    Parameter
    Name
    Value
    Description
    * offset
    query

    Offset (optional)- This is the position in the dataset of a particular record. By specifying offset, you retrieve a subset of records starting with the offset value. Offset is zero-based i.e. the 10th record is at offset 9

    * limit
    query

    limit (optional)-number of records on single page

    default = 20

    * name
    query

    name(optional)- Search by Campaign name 

    * sort_by
    query

    sort_by (optional) This indicates in what order the campaign records are sorted in the API response. By default records are sorted by DateCreated in ascending order. However, you can override the same in following way for ascending order: Eg: date_created:asc or name:asc

    * list_sids
    query

    list_sids(optional)-fetch the details of contacts belonging to a particular list

    * filter
    query

    filter(optional) -If filter is “show_list” Response will contain associated list data too in contacts.

    Response Content Type
  • Try it Now
    • DELETE

    https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/contacts/<contactSid>

    To delete a specific contact, try out this API

    Parameter
    Name
    Value
    Description
    * ID
    path

    Replace <id> with the contactSid

    Response Content Type
  • Try it Now