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

You can use groups to segment users when sending emails. Currently, a contact can only be in one user group. Read more

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.

{
  "mailingLists": {
    "cm06f5v0e45nf0ml5754o9cix": true,
    "cm16k73gq014h0mmj5b6jdi9r": false
  }
}

Successful create.

successboolean required

idstring required

{
  "success": true
}