Contacts

This section details endpoints dedicated to managing contacts effectively, facilitating streamlined interaction and organization within the platform.

Search Contacts: Search and retrieve contacts based on specified parameters or keywords, enabling efficient categorization and retrieval.

Add Contact: Create and add new contacts to the platform by providing the necessary contact details via this endpoint.

Get Contact By Id: Retrieve detailed information about a specific contact using its unique identifier (contactId).

Delete Contact: Delete a specific contact from the platform, identified by its unique identifier (contactId).

Update Contact: Modify and update contact information for a specific contact identified by its unique identifier (contactId).

Add Tag to Contact: Associate tags with a specific contact, enhancing categorization and triggering automations.

Remove Tag from Contact: Effortlessly remove tags associated with a specific contact, facilitating flexible tag management.

get

/v1/contacts

Authorizations

Query parameters

limitstring

tagsstring

locationIdstring

pagestring

channelstring

searchTextstring

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '<YOUR HOST>/v1/contacts' \
  --header 'x-api-key: text'

200

200

[
  {
    "id": "text",
    "name": "text",
    "phoneNumber": "text",
    "notes": "text",
    "customFields": {},
    "stage": "Subscriber",
    "tags": [
      "text"
    ],
    "location": {
      "id": "text",
      "title": "text"
    }
  }
]

200 response

post

/v1/contacts

Authorizations

Header parameters

x-api-keystringrequired

Body

idstring

namestringrequired

phoneNumberstringrequired

notesstring

customFieldsobject

stageenum

Options: Subscriber, Engaged, Lead, Marketing qualified lead (MQL), Sales qualified lead (SQL), Opportunity, Follow-up Required, Customer, Evangelist, Other, Lost, Inactive

tagsstring[]

locationobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '<YOUR HOST>/v1/contacts' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","phoneNumber":"text","customFields":{},"stage":"Subscriber","tags":[null],"location":{"id":"text","title":"text"}}'

200

200

{
  "id": "text",
  "name": "text",
  "phoneNumber": "text",
  "notes": "text",
  "customFields": {},
  "stage": "Subscriber",
  "tags": [
    "text"
  ],
  "location": {
    "id": "text",
    "title": "text"
  }
}

200 response

get

/v1/contacts/{contactId}

Authorizations

Path parameters

contactIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '<YOUR HOST>/v1/contacts/{contactId}' \
  --header 'x-api-key: text'

200

200

{
  "id": "text",
  "name": "text",
  "phoneNumber": "text",
  "notes": "text",
  "customFields": {},
  "stage": "Subscriber",
  "tags": [
    "text"
  ],
  "location": {
    "id": "text",
    "title": "text"
  }
}

200 response

delete

/v1/contacts/{contactId}

Authorizations

Path parameters

contactIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '<YOUR HOST>/v1/contacts/{contactId}' \
  --header 'x-api-key: text'

200

200

{
  "success": true
}

200 response

put

/v1/contacts/{contactId}

Authorizations

Path parameters

contactIdstringrequired

Header parameters

x-api-keystringrequired

Body

idstring

namestringrequired

phoneNumberstringrequired

notesstring

customFieldsobject

stageenum

Options: Subscriber, Engaged, Lead, Marketing qualified lead (MQL), Sales qualified lead (SQL), Opportunity, Follow-up Required, Customer, Evangelist, Other, Lost, Inactive

tagsstring[]

locationobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '<YOUR HOST>/v1/contacts/{contactId}' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","phoneNumber":"text","customFields":{},"stage":"Subscriber","tags":[null],"location":{"id":"text","title":"text"}}'

200

200

{
  "id": "text",
  "name": "text",
  "phoneNumber": "text",
  "notes": "text",
  "customFields": {},
  "stage": "Subscriber",
  "tags": [
    "text"
  ],
  "location": {
    "id": "text",
    "title": "text"
  }
}

200 response

post

/v1/contacts/{contactId}/tags/add

Authorizations

Path parameters

proxystringrequired

contactIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '<YOUR HOST>/v1/contacts/{contactId}/tags/add' \
  --header 'x-api-key: text'

200

200

{
  "id": "text",
  "tags": [
    "text"
  ]
}

200 response

post

/v1/contacts/{contactId}/tags/remove

Authorizations

Path parameters

proxystringrequired

contactIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '<YOUR HOST>/v1/contacts/{contactId}/tags/remove' \
  --header 'x-api-key: text'

200

200

{
  "id": "text",
  "tags": [
    "text"
  ]
}

200 response