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<YOUR HOST>/v1/contacts

Authorization

api_key

Query parameters

Header parameters

Response

200

200 response

Body

application/json

idstring

name*string

phoneNumber*string

location*object

stageenum

SubscriberEngagedLeadMarketing qualified lead (MQL)Sales qualified lead (SQL)OpportunityFollow-up RequiredCustomerEvangelistOtherLostInactive

notesstring

customFieldsobject

tagsarray of string

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/contacts', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

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

POST<YOUR HOST>/v1/contacts

Authorization

api_key

Header parameters

Body

application/json

idstring

name*string

phoneNumber*string

location*object

stageenum

SubscriberEngagedLeadMarketing qualified lead (MQL)Sales qualified lead (SQL)OpportunityFollow-up RequiredCustomerEvangelistOtherLostInactive

notesstring

customFieldsobject

tagsarray of string

Response

200

200 response

Body

application/json

idstring

name*string

phoneNumber*string

location*object

stageenum

SubscriberEngagedLeadMarketing qualified lead (MQL)Sales qualified lead (SQL)OpportunityFollow-up RequiredCustomerEvangelistOtherLostInactive

notesstring

customFieldsobject

tagsarray of string

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/contacts', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "location": {
        "id": "text"
      },
      "name": "text",
      "phoneNumber": "text"
    }),
});
const data = await response.json();

Response

200

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

GET<YOUR HOST>/v1/contacts/{contactId}

Authorization

api_key

Path parameters

contactId*string

Header parameters

Response

200

200 response

Body

application/json

idstring

name*string

phoneNumber*string

location*object

stageenum

SubscriberEngagedLeadMarketing qualified lead (MQL)Sales qualified lead (SQL)OpportunityFollow-up RequiredCustomerEvangelistOtherLostInactive

notesstring

customFieldsobject

tagsarray of string

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/contacts/{contactId}', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

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

DELETE<YOUR HOST>/v1/contacts/{contactId}

Authorization

api_key

Path parameters

contactId*string

Header parameters

Response

200

200 response

Body

application/json

successboolean

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/contacts/{contactId}', {
    method: 'DELETE',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

{
  "success": false
}

PUT<YOUR HOST>/v1/contacts/{contactId}

Authorization

api_key

Path parameters

contactId*string

Header parameters

Body

application/json

idstring

name*string

phoneNumber*string

location*object

stageenum

SubscriberEngagedLeadMarketing qualified lead (MQL)Sales qualified lead (SQL)OpportunityFollow-up RequiredCustomerEvangelistOtherLostInactive

notesstring

customFieldsobject

tagsarray of string

Response

200

200 response

Body

application/json

idstring

name*string

phoneNumber*string

location*object

stageenum

SubscriberEngagedLeadMarketing qualified lead (MQL)Sales qualified lead (SQL)OpportunityFollow-up RequiredCustomerEvangelistOtherLostInactive

notesstring

customFieldsobject

tagsarray of string

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/contacts/{contactId}', {
    method: 'PUT',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "location": {
        "id": "text"
      },
      "name": "text",
      "phoneNumber": "text"
    }),
});
const data = await response.json();

Response

200

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

POST<YOUR HOST>/v1/contacts/{contactId}/tags/add

Authorization

api_key

Path parameters

proxy*string

contactId*string

Header parameters

Response

200

200 response

Body

application/json

idstring

tagsarray of string

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/contacts/{contactId}/tags/add', {
    method: 'POST',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

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

POST<YOUR HOST>/v1/contacts/{contactId}/tags/remove

Authorization

api_key

Path parameters

proxy*string

contactId*string

Header parameters

Response

200

200 response

Body

application/json

idstring

tagsarray of string

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/contacts/{contactId}/tags/remove', {
    method: 'POST',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

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