GuidesRecipesAPI Reference
API Reference
Select productLog inHelp centre

Replace a contact

put
https://{region}-api.dotdigital.com/contacts/v3//

Replaces a contact entirly with the data passed in the request.

Note:

  • This call will replace the entire contact when updating with the data passed; if would like to change just select fields then use the PATCH call.
Path Params
string
required
length between 1 and 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
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
string

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

Responses

401

Unauthorized

Updated 4 months ago

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