Skip to main content
POST
This is the recommended endpoint for most contact synchronization scenarios.

Authorizations

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

Body

Contact information to create or update
For the optional fields firstName, lastName, userId, and mobile, sending an empty string ("") clears the stored value on an existing contact. Sending null or omitting the field leaves the current value unchanged.
string<email>
required
Valid email address (automatically normalized to lowercase)Example: "[email protected]"
string | null
Contact’s first nameSend an empty string ("") to clear this field on an existing contact. Sending null or omitting it leaves the current value unchanged.Example: "John"
string | null
Contact’s last nameSend an empty string ("") to clear this field on an existing contact. Sending null or omitting it leaves the current value unchanged.Example: "Doe"
string | null
An optional reference field to store your application’s user ID. Use this to map your internal users to AutoSend contacts.Send an empty string ("") to clear this field on an existing contact. Sending null or omitting it leaves the current value unchanged.Example: "user_12345"
string | null
Contact’s mobile number in E.164 format.Send an empty string ("") to clear this field on an existing contact. Sending null or omitting it leaves the current value unchanged.Example: "+14155552671"
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 or updated successfully
boolean
Indicates if the request was successfulExample: true
object