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

Authorizations

x-api-keystringRequired

Query parameters

limitstringOptional

tagsstringOptional

locationIdstringOptional

pagestringOptional

channelstringOptional

searchTextstringOptional

Header parameters

x-api-keystringRequired

Responses

200

200 response

application/json

idstringOptional

namestringRequired

phoneNumberstringRequired

stagestring · enumOptionalPossible values:

notesstringOptional

customFieldsobjectOptional

tagsstring[]Optional

get/v1/contacts

GET /v1/contacts HTTP/1.1
x-api-key: text
Accept: */*

200

200 response

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

post

Authorizations

x-api-keystringRequired

Header parameters

x-api-keystringRequired

Body

idstringOptional

namestringRequired

phoneNumberstringRequired

stagestring · enumOptionalPossible values:

notesstringOptional

customFieldsobjectOptional

tagsstring[]Optional

Responses

200

200 response

application/json

idstringOptional

namestringRequired

phoneNumberstringRequired

stagestring · enumOptionalPossible values:

notesstringOptional

customFieldsobjectOptional

tagsstring[]Optional

post/v1/contacts

POST /v1/contacts HTTP/1.1
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 158

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

200

200 response

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

get

Authorizations

x-api-keystringRequired

Path parameters

contactIdstringRequired

Header parameters

x-api-keystringRequired

Responses

200

200 response

application/json

idstringOptional

namestringRequired

phoneNumberstringRequired

stagestring · enumOptionalPossible values:

notesstringOptional

customFieldsobjectOptional

tagsstring[]Optional

get/v1/contacts/{contactId}

GET /v1/contacts/{contactId} HTTP/1.1
x-api-key: text
Accept: */*

200

200 response

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

delete

Authorizations

x-api-keystringRequired

Path parameters

contactIdstringRequired

Header parameters

x-api-keystringRequired

Responses

200

200 response

application/json

successbooleanOptional

delete/v1/contacts/{contactId}

DELETE /v1/contacts/{contactId} HTTP/1.1
x-api-key: text
Accept: */*

200

200 response

{
  "success": true
}

put

Authorizations

x-api-keystringRequired

Path parameters

contactIdstringRequired

Header parameters

x-api-keystringRequired

Body

idstringOptional

namestringRequired

phoneNumberstringRequired

stagestring · enumOptionalPossible values:

notesstringOptional

customFieldsobjectOptional

tagsstring[]Optional

Responses

200

200 response

application/json

idstringOptional

namestringRequired

phoneNumberstringRequired

stagestring · enumOptionalPossible values:

notesstringOptional

customFieldsobjectOptional

tagsstring[]Optional

put/v1/contacts/{contactId}

PUT /v1/contacts/{contactId} HTTP/1.1
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 158

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

200

200 response

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

post

Authorizations

x-api-keystringRequired

Path parameters

proxystringRequired

contactIdstringRequired

Header parameters

x-api-keystringRequired

Responses

200

200 response

application/json

idstringOptional

tagsstring[]Optional

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

POST /v1/contacts/{contactId}/tags/add HTTP/1.1
x-api-key: text
Accept: */*

200

200 response

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

post

Authorizations

x-api-keystringRequired

Path parameters

proxystringRequired

contactIdstringRequired

Header parameters

x-api-keystringRequired

Responses

200

200 response

application/json

idstringOptional

tagsstring[]Optional

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

POST /v1/contacts/{contactId}/tags/remove HTTP/1.1
x-api-key: text
Accept: */*

200

200 response

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