Skip to main content
PUT
/
v2
/
lists
/
{id}
Update List (v2)
curl --request PUT \
  --url https://api.heymarket.com/v2/lists/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contacts": [
    123
  ],
  "phones": [
    "<string>"
  ],
  "emails": [
    "<string>"
  ],
  "title": "<string>",
  "add_contacts": [
    123
  ],
  "remove_contacts": [
    123
  ],
  "add_phones": [
    "<string>"
  ],
  "remove_phones": [
    "<string>"
  ],
  "add_emails": [
    "<string>"
  ],
  "remove_emails": [
    "<string>"
  ]
}
'
{
  "id": 123,
  "rev": 123,
  "uuid": "<string>"
}
Use this endpoint to rename a list or change its membership.

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

List ID

Body

application/json

List json

​
contacts
integer[]

Array of contact IDs to replace/set the list membership

​
phones
string[]

Phone numbers in E.164 format (without plus sign) to add as new contacts

​
emails
string[]

Email addresses to add as new contacts

​
title
string

List name

​
add_contacts
integer[]

Array of contact IDs to add to the list

​
remove_contacts
integer[]

Array of contact IDs to remove from the list

​
add_phones
string[]

Phone numbers in E.164 format (without plus sign) to add as new contacts

​
remove_phones
string[]

Phone numbers in E.164 format (without plus sign) to remove from the list

​
add_emails
string[]

Email addresses to add as new contacts

​
remove_emails
string[]

Email addresses to remove from the list

Response

OK

​
id
integer
​
rev
integer
​
uuid
string