Skip to main content
PATCH
/
audience
/
contacts
/
{contactId}
Update a contact
curl --request PATCH \
  --url https://app.lettr.com/api/audience/contacts/{contactId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "properties": {}
}
'
{
  "message": "Contact retrieved successfully.",
  "data": {
    "id": "0193e6b0-9c1d-7d4f-a8f1-cef9a1b2d3e4",
    "email": "jane@example.com",
    "status": "subscribed",
    "properties": {
      "first_name": "Jane",
      "country": "US"
    },
    "created_at": "2024-01-15T10:30:00Z",
    "lists": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    ],
    "topics": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    ]
  }
}
Partially update a contact. If no fields are provided the contact is returned unchanged. Requires the audience:write scope and is blocked for sandbox API keys.

Authorizations

​
Authorization
string
header
required

API key for authentication

Path Parameters

​
contactId
string<uuid>
required

Contact ID

Body

application/json

Request to update a contact. All fields are optional.

​
email
string<email>

New email address (must remain unique within the team)

Maximum string length: 255
​
status
enum<string>
Available options:
subscribed,
unsubscribed
​
properties
object

Partial property update. A property set to null is removed.

Response

Updated

​
message
string
required
Example:

"Contact retrieved successfully."

​
data
object
required

Audience contact