POST
/
contacts
curl --request POST \
  --url https://wt.ls/api/v4/contacts \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --data '{
  "email": "<string>",
  "listId": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "phoneNumber": "<string>",
  "customData": {},
  "address": "<string>",
  "isGDPR": true,
  "name": "<string>",
  "instagram": "<string>",
  "twitter": "<string>",
  "website": "<string>",
  "company": "<string>",
  "country": "<string>",
  "city": "<string>"
}'
{
  "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,
      "customData": {},
      "address": "<string>",
      "isGDPR": true,
      "name": "<string>",
      "instagram": "<string>",
      "twitter": "<string>",
      "website": "<string>",
      "company": "<string>",
      "country": "<string>",
      "city": "<string>",
      "list": {},
      "audiences": [
        "<any>"
      ],
      "referralLink": "<string>",
      "privateLink": "<string>",
      "position": 123
    }
  }
}

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

​
customData
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

Response

201
application/json
Contact created successfully
​
data
object
IntroductionRetrieve Contact