Audience

Update a contact

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.

patch/audience/contacts/{contactId}

Request

  • Base URL: https://app.lettr.com/api
  • URL: https://app.lettr.com/api/audience/contacts/{contactId}
  • Auth: HTTP bearer

Path parameters

contactIdstring uuid required

Contact ID

Request body

emailstring email

New email address (must remain unique within the team)

status'subscribed' | 'unsubscribed'
propertiesobject

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

Response

Updated

messagestring required

Example response

{
  "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"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.