Update Contact

PATCH

https://api.mailchimp.com/3.0/audiences/:audience_id/contacts/:contact_id

PATCH

/3.0/audiences/:audience_id/contacts/:contact_id

curl -X PATCH https://api.mailchimp.com/3.0/audiences/audience_id/contacts/contact_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

200Updated

{
  "audience_id": "773280e405",
  "created_at": "2024-01-15T09:30:00Z",
  "email_channel": {
    "effective_subscription_status": {
      "value": "subscribed"
    },
    "email": "example@freddiemail.com",
    "hashed_email": "9115d71ba28088047d342e3bcedacd0f",
    "marketing_consent": {
      "source": {
        "name": "string"
      },
      "status": "consented",
      "captured_at": "2024-01-15T10:30:00Z"
    },
    "source": {
      "name": "string"
    }
  },
  "id": "7CCF816ADF6CE1B11AE09BB024A02B9B",
  "language": "en",
  "last_updated_at": "2024-01-15T09:30:00Z",
  "merge_fields": {},
  "sms_channel": {
    "effective_subscription_status": {
      "value": "subscribed"
    },
    "marketing_consent": {
      "source": {
        "name": "string"
      },
      "status": "consented",
      "captured_at": "2024-01-15T10:30:00Z"
    },
    "sms_phone": "+14045550102",
    "source": {
      "name": "string"
    },
    "hashed_sms_phone": "0572084e1f8288816f02cdb7bd930c62400bc8aef510adfaa9eec2b995fa7609"
  },
  "source": {
    "name": "string"
  },
  "status": "active",
  "tags": [
    "string"
  ]
}

Update an existing omni-channel contact.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

AuthorizationBearer

Authorization using OAuth

Path parameters

audience_idstringRequired

The unique ID for the audience.

contact_idstringRequired

The unique id for the contact.

Query parameters

merge_field_validation_modeenumOptional

Defines how merge field validation is handled. When set to ignore_required_checks, the API does not raise an error if required merge fields are missing from the request. When set to strict, the API enforces validation and returns an error if any required merge field is not provided. If this setting is omitted, strict is applied by default.

Allowed values:

data_modeenumOptional

Indicates the data processing mode. In historical mode, contact data changes do not trigger automations or webhooks. In live mode, such changes do trigger them.

Allowed values:

Request

An instance of a contact.

email_channelobjectOptional

languagestringOptional

The contact's detected language.

merge_fieldsmap from strings to objects or strings or doubles or nullOptional

A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure.

sms_channelobjectOptional

tagslist of strings or objectsOptional

An array of tags to add to the contact. Accepts tag name strings or objects with name and status. This operation is append-only; existing tags will be preserved, and only new tags from this array will be added.

Response

This endpoint returns an object.

audience_idstringOptionalRead-only

The unique ID for the audience.

created_atdatetimeOptionalRead-only

The date that the contact was created.

email_channelobjectOptional

idstringOptionalRead-only

The unique ID for the contact.

languageenumOptional

The contact's detected language. Empty string when no language has been detected or set.

last_updated_atdatetimeOptionalRead-only

The date that the contact was last updated.

merge_fieldsmap from strings to objects or strings or doubles or nullOptional

A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure.

sms_channelobjectOptional

sourceobjectOptional

The source from which the parent's entity was created.

statusenumOptionalRead-only

The status of a contact.

Allowed values:

tagslist of stringsOptional

The tags assigned to this contact.