Replace a contact

Replaces a contact with the data passed in the request.


Note:

  • This call replaces the contact's identifiers, dataFields, lists and preferences. Identifiers and data fields you do not specify are removed, and the contact is removed from lists and preferences you do not specify. If you do not specify mobileNumber, the contact's mobile number is deleted, and mobileNumber then has the value deleted.
  • This call does not replace the email channel properties. If the contact already has an email channel, the emailType, optInType, status and openTracking properties you do not specify remain unaltered. Defaults are only applied when the contact does not have an email channel yet.
  • This call does not change consent records. The contact's existing consent records are kept. To add consent records, use importContact (PATCH) or importContacts.
  • To change only some fields, use the PATCH call.

Replaces a contact entirely with the data passed in the request, including list membership. Because segments are recalculated dynamically from contact data, this can remove the contact from any segments it previously matched.

🚧

This call replaces the entire contact

This call will replace the entire contact when updating with the data passed allowing you to reset the entire contact to a known state; if you want to change only certain fields then use the PATCH call.

Path Params
string
required
length between 1 and 50
(^[-A-Za-z0-9_]{1,50}$)

The field to use to uniquely identify the contact. This can be a custom identifier or a contact identifer of contactId, email or mobileNumber

string
required
length between 1 and 256

The unique value to identify the contact.
Note: Must be the same type as the identifier

Body Params

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

identifiers
object
required

Identifiers this contact can be referenced by

dataFields
object

Addtional data fields for the contact

channelProperties
object

Properties associated with each channel for a contact. For example, message format or subscription status

lists
array of int32s
length between 1 and 100

List IDs for the lists the contact should be added to

lists

Unique list id

preferences
array of objects
length ≥ 1

Preferences you want to opt the contact into. Note: Only required for preferences and not preference categories

preferences
int32
required

ID of the preference

boolean
required

Specify whether the contact is opted into this preference

Headers
uuid

If you are a partner of Dotdigital and have a verified integration then include your integration tracking token here.

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