Skip to main content

​
Contact Service

The Contact Service allows you to manage contacts in your workspace. You can create, read, update, and delete contacts.

​
Create Contact

Create a new contact in your workspace. 
POST /contact

​
Request Body

FieldTypeRequiredDescription
first_namestringNoContact’s first name
last_namestringNoContact’s last name
phonestringYesContact’s phone number in E.164 format (e.g., +1234567890)
emailstringNoContact’s email address
additional_notesstringNoAdditional notes about the contact

​
Example Request

{
  "first_name": "John",
  "last_name": "Doe",
  "phone": "+1234567890",
  "email": "[email protected]",
  "additional_notes": "VIP customer"
}

​
Response

{
  "status": 201,
  "data": {
    "id": "contact-123",
    "created_at": "2024-03-20T10:00:00Z",
    "first_name": "John",
    "last_name": "Doe",
    "phone": "+1234567890",
    "email": "[email protected]",
    "additional_notes": "VIP customer",
    "status": "active",
    "updated_at": "2024-03-20T10:00:00Z",
    "workspace_id": "workspace-123"
  }
}

​
Get Contact

Retrieve a specific contact by ID. 
GET /contact/{id}

​
Parameters

ParameterTypeRequiredDescription
idstringYesThe ID of the contact to retrieve

​
Response

{
  "id": "contact-123",
  "created_at": "2024-03-20T10:00:00Z",
  "first_name": "John",
  "last_name": "Doe",
  "phone": "+1234567890",
  "email": "[email protected]",
  "additional_notes": "VIP customer",
  "status": "active",
  "updated_at": "2024-03-20T10:00:00Z",
  "workspace_id": "workspace-123",
  "campaign_id": "campaign-123"
}

​
Update Contact

Update an existing contact. 
PUT /contact/{id}

​
Parameters

ParameterTypeRequiredDescription
idstringYesThe ID of the contact to update

​
Request Body

FieldTypeRequiredDescription
first_namestringNoContact’s first name
last_namestringNoContact’s last name
phonestringNoContact’s phone number in E.164 format
emailstringNoContact’s email address
additional_notesstringNoAdditional notes about the contact

​
Example Request

{
  "first_name": "John",
  "last_name": "Smith",
  "phone": "+1987654321",
  "email": "[email protected]",
  "additional_notes": "Updated VIP customer"
}

​
Response

{
  "status": 200,
  "data": {
    "id": "contact-123",
    "created_at": "2024-03-20T10:00:00Z",
    "first_name": "John",
    "last_name": "Smith",
    "phone": "+1987654321",
    "email": "[email protected]",
    "additional_notes": "Updated VIP customer",
    "status": "active",
    "updated_at": "2024-03-20T11:00:00Z",
    "workspace_id": "workspace-123"
  }
}

​
Delete Contact

Delete a contact from your workspace. 
DELETE /contact/{id}

​
Parameters

ParameterTypeRequiredDescription
idstringYesThe ID of the contact to delete

​
Response

{
  "status": 200,
  "message": "Contact deleted successfully"
}