Sign in

v4

latestOpenAPI 3.1.02026-07-3163216290.7 KB
Contacts

Update a contact

Update a contact by email or userId. You must provide one of these parameters.

If you want to update a contact's email address, the contact will first need a userId value. You can then make a request containing the userId field along with an updated email address.

This endpoint will create a contact if a matching contact does not already exist in your audience.

Provide either email or userId to identify the contact you want to update. If both are provided, the system will look for a contact with either a matching email or userId value. If a contact is found for one of the values (e.g. email), the other value (e.g. userId) will be updated. If a contact is not found, a new contact will be created using both email and userId values.

put/v1/contacts/update

Request body

OR

Example request

{
  "email": "alex@company.com",
  "firstName": "Alex",
  "lastName": "Rivera",
  "subscribed": true,
  "userGroup": "customers",
  "userId": "usr_7f8e9d0c1b2a",
  "mailingLists": {
    "clm2k8j4h6g0f8d6s4a2b0z8": true
  },
  "favoriteColor": "blue"
}

Response

Successful update.

successboolean required
idstring required

Example response

{
  "success": true,
  "id": "clh3k9m2p4q6r8s0t2v4x6z8"
}