Sign in

v1

latestOpenAPI 3.0.02026-08-063524105.9 KB
Contacts

Update contact

Updates contact details. All fields are optional - only provided fields will be updated. Cannot update soft-deleted contacts (returns 404).

patch/v1/contacts/{id}

Path parameters

idstring uuid required

Contact UUID

Example:123e4567-e89b-12d3-a456-426614174000

Request body

firstNamestring nullable

Contact first name (can be set to null)

lastNamestring nullable

Contact last name (can be set to null)

emailstring email nullable

Contact email (can be set to null)

phonestring nullable

Contact phone (can be set to null)

Example request

{
  "firstName": "Jane",
  "lastName": "Smith",
  "email": "jane.smith@example.com",
  "phone": "+1-555-987-6543"
}

Response

Contact updated 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"
}