Sign in

v1

latestOpenAPI 3.0.02026-08-063524105.9 KB
Contacts

Create contact

Create a new contact within a workspace. Only workspaceId is required. Optional fields include contactListId, firstName, lastName, email, and phone.

post/v1/contacts

Request body

workspaceIdstring uuid required

Workspace ID to create contact in (required)

contactListIdstring uuid

Contact list ID to assign contact to

firstNamestring

Contact first name

lastNamestring

Contact last name

emailstring email

Contact email address

phonestring

Contact phone number

Example request

{
  "workspaceId": "789e4567-e89b-12d3-a456-426614174000",
  "contactListId": "456e4567-e89b-12d3-a456-426614174000",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phone": "+1-555-123-4567"
}

Response

Contact created successfully

idstring uuid required

Unique contact identifier

workspaceIdstring uuid required

Workspace ID that owns this contact

contactListIdstring uuid nullable required

Contact list ID (null if not in a list)

firstNamestring nullable required

Contact first name

lastNamestring nullable required

Contact last name

emailstring email nullable required

Contact email address

phonestring nullable required

Contact phone number

createdAtstring date-time required

Contact creation timestamp

updatedAtstring date-time required

Contact last update timestamp

deletedAtstring date-time nullable required

Soft delete timestamp (null if active)

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "789e4567-e89b-12d3-a456-426614174000",
  "contactListId": "456e4567-e89b-12d3-a456-426614174000",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phone": "+1-555-123-4567",
  "createdAt": "2025-12-11T12:00:00Z",
  "updatedAt": "2025-12-11T12:00:00Z"
}