Skip to main content
POST
Use this API when you know the contact is new. Use Upsert Contact when the contact may already exist. It will create or update without throwing an error.

Authorizations

string | header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

Contact information to create
string<email>
required
Valid email address (automatically normalized to lowercase)Example: "[email protected]"
string
Contact’s first nameExample: "John"
string
Contact’s last nameExample: "Doe"
string
An optional reference field to store your application’s user ID. Use this to map your internal users to AutoSend contacts.Example: "user_12345"
array
IDs of the contact lists to add this contact to. You can find list IDs in your AutoSend Dashboard.Do not pass segment IDs here. Segments are computed automatically based on contact field values. Adding a contact to a list will also trigger any live automations associated with that list.Example: ["507f1f77bcf86cd799439011"]
object
Key-value pairs for custom contact attributes. There are four supported value types: string, number, boolean, and date. Learn more about contact properties.Example:

Response

Contact created successfully
boolean
Indicates if the request was successfulExample: true
object