Import a single contact

📘

Request behavior

The identifier specified in the URL path is used to uniquely identify a contact. This can be a custom identifier or a system contact identifier; contactId, email, or mobileNumber.

Existing contacts

When we find a contact in the account with the specified identifier, the contact record is updated with any data supplied in the object in the request body.

Deleted contacts

When we find a contact in the recycled bin with the same identifier that you pass in, we will undelete the contact and update with the passed details.

New contacts

If no contact is found with the provided identifier, the contact is created using the identifiers supplied in the object in the request body. The object must contain either an email address or mobile number in the identifiers field.

🚧

Specifying null for a field's value clears the field

Only pass the fields you require updating for a contact.

We interpret a field passed with a null value (in other words, an empty field) as an instruction to clear the value for that field.

Note: This only works with data fields in this call,not identifiers.

Path Params
string
required
length between 1 and 50
string
required
length between 1 and 256
Query Params
string
enum
Defaults to overwrite
Allowed:
Body Params

The contact fields to update. Note: It is not possible to modify the contactId field

identifiers
object
dataFields
object
channelProperties
object
lists
array of int32s
length between 1 and 100
lists

preferences
array of objects
length ≥ 1
preferences
int32
required
boolean
required
consentRecords
array of objects
length between 1 and 5
consentRecords

string
required
length ≥ 1
date-time
required
uri
required
required
string
required
length ≥ 1
Headers
string
Responses

401

Unauthorized

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json