Skip to main content
PUT
/
api
/
v1
/
contacts
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": "john.smith@example.com",
  "defaultTimeZone": "America/New_York",
  "metadata": {
    "source": "updated_via_api",
    "last_interaction": "2024-01-15"
  }
}'
{
  "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": "john.smith@example.com",
    "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:

"john@example.com"

​
defaultTimeZone
string

Contact's default timezone

Example:

"America/New_York"

​
metadata
object

Custom key-value pairs to store with the contact

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

Response

Contact updated successfully

​
data
object
​
message
string

Status message

Example:

"Contact updated successfully"

⌘I