Skip to main content
POST
/
audience
/
contacts
Create a contact
curl --request POST \
  --url https://app.lettr.com/api/audience/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jane@example.com",
  "list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "properties": {
    "first_name": "Jane"
  }
}
'
{
  "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>"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.lettr.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

Authorizations

​
Authorization
string
header
required

API key for authentication

Body

application/json

Request to create a single contact

​
email
string<email>
required
Maximum string length: 255
Example:

"jane@example.com"

​
list_id
string<uuid> | null

Optional list to add the contact to

​
properties
object

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

Example:
{ "first_name": "Jane" }
​
double_opt_in
object

Double opt-in configuration. When provided, the contact receives a confirmation email and is created in unverified status until they click the confirmation link.

Response

Contact created

​
message
string
required
Example:

"Contact retrieved successfully."

​
data
object
required

Audience contact