Update Contact

Update an existing contact’s information. You can identify the contact using either ID, WhatsApp ID (waId), or SMS phone number (smsPhoneNumber). Only one identifier is required, but at least one must be provided.

Important Notes:

• If multiple contacts match the identifier, the operation will fail with a 409 error
• If no contacts are found, the operation will return a 404 error
• Only contacts that your organization has access to can be updated
• All fields except the identifier are optional and will only be updated if provided

PUT /api/v1/contacts

cURL

update_by_id

curl --request PUT \ --url https://chat.trysetter.com/api/v1/contacts \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "id": 123, "firstName": "John", "lastName": "Smith", "email": "[e-mail]", "defaultTimeZone": "America/New_York", "metadata": { "source": "updated_via_api", "last_interaction": "2024-01-15" } } '

200

Example

{ "data": { "id": 123, "createdAt": "2024-01-01T10:00:00Z", "updatedAt": "2024-01-15T14:30:00Z", "firstName": "John", "lastName": "Smith", "fullName": "John Smith", "phoneNumber": "1234567890", "waId": "1234567890", "smsPhoneNumber": "1234567890", "email": "[e-mail]", "defaultTimeZone": "America/New_York", "metadata": { "source": "updated_via_api", "last_interaction": "2024-01-15" } } }

Authorizations

Authorization · string · header · required

Bearer token authentication using your API key

Body

application/json

id · integer

Contact ID for direct lookup

Example:

123

waId · string

WhatsApp ID for contact lookup

Example:

"1234567890"

smsPhoneNumber · string

SMS phone number for contact lookup

Example:

"1234567890"

firstName · string

Contact's first name

Example:

"John"

lastName · string

Contact's last name

Example:

"Doe"

fullName · string

Contact's full name

Example:

"John Doe"

phoneNumber · string

Contact's phone number

Example:

"1234567890"

email · string<email>

Contact's email address

Example:

"[e-mail]"

defaultTimeZone · string

Contact's default timezone

Example:

"America/New_York"

metadata · object

Custom key-value pairs to store with the contact

Show child attributes

Example:

{
  "source": "website",
  "campaign": "summer2024"
}

Response

200

application/json

Contact updated successfully

data · object

Show child attributes

message · string

Status message

Example:

"Contact updated successfully"