v4

latestOpenAPI 3.1.02026-07-3163216290.7 KB

Contacts

Create a contact

Add a contact to your audience.

post/v1/contacts/create

Request body

emailstring required

The contact's email address.

firstNamestring

The contact's first name.

lastNamestring

The contact's last name.

sourcestring

A custom source value to replace the default “API”.

subscribedboolean

Whether the contact will receive campaign and workflow emails. All new contacts are subscribed by default.

userGroupstring

The contact's user group.

userIdstring

A unique user ID (for example, from an external application).

mailingListsMailingListSubscriptions

Manage mailing list subscriptions.

Include key-value pairs of mailing list IDs and a boolean denoting if the contact should be added (true) or removed (false) from the list.

Example request

{
  "email": "alex@company.com",
  "firstName": "Alex",
  "lastName": "Rivera",
  "subscribed": true,
  "userGroup": "customers",
  "userId": "usr_7f8e9d0c1b2a",
  "mailingLists": {
    "clm2k8j4h6g0f8d6s4a2b0z8": true
  },
  "favoriteColor": "blue"
}

Response

Successful create.

successboolean required

idstring required

Example response

{
  "success": true,
  "id": "clh3k9m2p4q6r8s0t2v4x6z8"
}