Skip to main content
POST
/
contacts
cURL
curl --request POST \
  --url https://letterby.com/api/v4/contacts \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --data '
{
  "email": "<string>",
  "listId": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "phoneNumber": "<string>",
  "data": {},
  "address": "<string>",
  "isGDPR": true,
  "name": "<string>",
  "instagram": "<string>",
  "twitter": "<string>",
  "website": "<string>",
  "company": "<string>",
  "country": "<string>",
  "city": "<string>",
  "sendVerificationEmail": true
}
'
{
  "data": {
    "contact": {
      "id": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "phoneNumber": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "points": 123,
      "referrals": 123,
      "listId": "<string>",
      "isVerified": true,
      "unsubscribed": true,
      "data": {},
      "address": "<string>",
      "isGDPR": true,
      "name": "<string>",
      "instagram": "<string>",
      "twitter": "<string>",
      "website": "<string>",
      "company": "<string>",
      "country": "<string>",
      "city": "<string>",
      "list": {
        "id": "<string>",
        "name": "<string>",
        "url": "<string>",
        "mode": "<string>",
        "referrals": true,
        "color": "<string>",
        "title": "<string>",
        "desc": "<string>"
      },
      "audiences": "<array>",
      "referralLink": "<string>",
      "privateLink": "<string>",
      "position": 123
    }
  }
}

Documentation Index

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

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

Authorizations

apiKey
string
header
required

API key to authorize requests

Body

application/json
email
string
required

Email address of the contact

listId
string
required

ID of the list this contact belongs to

firstName
string

First name of the contact

lastName
string

Last name of the contact

phoneNumber
string

Phone number of the contact

data
object

Custom data associated with the contact

address
string

Contact's address

isGDPR
boolean

Whether the contact has GDPR consent

name
string

Full name of the contact

instagram
string

Instagram handle

twitter
string

Twitter handle

website
string

Personal website URL

company
string

Company name

country
string

Country of residence

city
string

City of residence

sendVerificationEmail
boolean
default:true

Whether to send a verification email to the contact (defaults to true)

Response

Contact created successfully

data
object