Contacts

Contacts

Get all Contacts

get

Retrieve all contacts for a specific workspace with pagination.

Authorizations

apiAuth

Path parameters

workspaceIdstringRequired

ID of the workspace

Query parameters

pageintegerOptional

Page number for pagination

per_pageintegerOptional

Number of records per page

Responses

200

Success

application/json

current_pageintegerOptional

last_pageintegerOptional

per_pageintegerOptional

totalintegerOptional

404

Contacts not found

get

/api/workspaces/{workspaceId}/contacts

HTTPcURLJavaScriptPython

GET /api/workspaces/{workspaceId}/contacts HTTP/1.1
Accept: */*

{
  "data": [
    {
      "id": "text",
      "workspace_id": "text",
      "identifiers": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "attributes": {}
    }
  ],
  "current_page": 1,
  "last_page": 1,
  "per_page": 1,
  "total": 1
}

Create a new contact

post

Create a new contact for a specific workspace.

Authorizations

apiAuth

Path parameters

workspaceIdstringRequired

ID of the workspace

Body

application/json

Responses

200

Contact created successfully

application/json

idstringRequired

UUID of the contact

workspace_idstringRequired

ID of the workspace the contact belongs to

attributesobjectRequired

List of attributes with their values

400

Validation Error(s)

application/json

404

Workspace not found

application/json

post

/api/workspaces/{workspaceId}/contacts

HTTPcURLJavaScriptPython

POST /api/workspaces/{workspaceId}/contacts HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 148

{
  "identifiers": [
    {
      "key": "email-address",
      "value": "[email protected]"
    }
  ],
  "attributes": {
    "first-name": "John",
    "last-name": "Doe",
    "subscribed-whatsapp": true
  }
}

{
  "id": "text",
  "workspace_id": "text",
  "identifiers": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "attributes": {}
}

Delete a contact and all its related data

delete

Delete a contact by its ID along with its identifiers and attributes.

Path parameters

workspaceIdstringRequired

ID of the workspace

contactIdstringRequired

ID of the contact

Responses

200

Contact deleted successfully

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Contact deleted successfully

404

Contact not found

application/json

delete

/api/workspaces/{workspaceId}/contacts/{contactId}

HTTPcURLJavaScriptPython

DELETE /api/workspaces/{workspaceId}/contacts/{contactId} HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "Contact deleted successfully"
}

Update a Contact

patch

Update an existing contact for a specific workspace.

Authorizations

apiAuth

Path parameters

workspaceIdstringRequired

ID of the workspace

contactIdstringRequired

ID of the contact

Body

application/json

Responses

200

Success

application/json

messagestringOptionalExample: Contact updated successfully.

400

Validation Error(s)

404

Contact not found

patch

/api/workspaces/{workspaceId}/contacts/{contactId}

HTTPcURLJavaScriptPython

PATCH /api/workspaces/{workspaceId}/contacts/{contactId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "identifiers": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {
      "": "text"
    }
  }
}

{
  "message": "Contact updated successfully."
}