Audience

Create a contact

Create a single contact. If double_opt_in is provided the contact is created in unverified status and receives a confirmation email — they become subscribed only after clicking the confirmation link. Requires the audience:write scope and is blocked for sandbox API keys.

post/audience/contacts

Request

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

Request body

emailstring email required
list_idstring uuid nullable

Optional list to add the contact to. Must be a list of your team, otherwise the response is 422 with errors.list_id.

propertiesobject nullable

Custom property values. Each key must match a property defined for the team.

Example request

{
  "email": "jane@example.com",
  "properties": {
    "first_name": "Jane"
  },
  "double_opt_in": {
    "from": "no-reply@example.com",
    "from_name": "Example Newsletter",
    "subject": "Please confirm your subscription",
    "template_slug": "double-opt-in",
    "redirect_url": "https://example.com/confirmed"
  }
}

Response

Contact created

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.