Skip to main content
PUT
/
v1
/
contact
/
{id}
Update Contact
curl --request PUT \
  --url https://api.heymarket.com/v1/contact/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "12345678900",
  "avatar": "https://some.image.url.com/img.jpg",
  "custom": {},
  "display_name": "John Smith",
  "email": "john.s@heymarket.com",
  "first": "John",
  "last": "Smith",
  "assignee_id": 42,
  "tags": [
    {
      "tag_id": 1
    },
    {
      "tag_id": 2
    }
  ],
  "is_opted_out": true,
  "email_suppressions": [
    123
  ]
}
'
{
  "id": 123,
  "rev": 123,
  "uuid": "<string>"
}
Use this endpoint to update a v1 contact. The overwrite query parameter controls whether custom fields are merged or replaced.

Authorizations

​
Authorization
string
header
required

Recommended authentication for new integrations. Generate a short-lived JWT from your API Secret ID and API Secret Key, then pass the signed JWT as a bearer token in the Authorization header.

API Secret credentials are available in the Heymarket app under Settings > Integrations > API. The Secret Key is shown only when it is generated, so copy and store it securely before closing the dialog.

Use the following JWT values:

{
  "alg": "HS256",
  "typ": "JWT"
}
{
  "iss": "YOUR_API_SECRET_ID",
  "iat": CURRENT_UNIX_TIMESTAMP
}

Replace CURRENT_UNIX_TIMESTAMP with the current Unix timestamp in seconds when generating the token.

Sign the JWT with HMAC-SHA256 using this signing secret:

YOUR_API_SECRET_ID||YOUR_API_SECRET_KEY

Send the signed JWT as a bearer token:

Authorization: Bearer YOUR_SIGNED_JWT

Tokens expire 5 minutes after the iat timestamp. Generate a new JWT per request, or cache it briefly for less than 5 minutes. Generate JWTs only from trusted server-side code; do not expose the API Secret Key in browser, mobile, or other client-side code.

Path Parameters

​
id
integer
required

Contact ID

Query Parameters

​
overwrite
boolean

Overwrite existing custom fields. Note that the contact's name is overwritten regardless of this parameter

Body

application/json

Contact json

​
phone
string<phone>
required
Example:

"12345678900"

​
avatar
string<url>
Example:

"https://some.image.url.com/img.jpg"

​
custom
object
​
display_name
string
Example:

"John Smith"

​
email
string<email>
Example:

"john.s@heymarket.com"

​
first
string
Example:

"John"

​
last
string
Example:

"Smith"

​
assignee_id
integer
Example:

42

​
tags
object[]
Example:
[{ "tag_id": 1 }, { "tag_id": 2 }]
​
is_opted_out
boolean
Example:

true

​
email_suppressions
integer[]

List of email suppression IDs to associate with the contact

Response

OK

​
id
integer
​
rev
integer
​
uuid
string