Skip to content

Mail

mail_contact_update

Update a contact (properties or unsubscribed flag)

Tool

mail_contact_update

Update a contact (properties or unsubscribed flag)

Update a contact (properties or unsubscribed flag)

Behavior

HTTP
PATCH /mail/audiences/:audienceId/contacts/:id

Arguments

NameTypeRequiredDescription
idstringContact id
propertiesobjectReplace the custom properties object
audience_idstringAudience id
unsubscribedbooleanSet the marketing opt-out flag

Response

FieldTypeAlwaysDescription
idstring
emailstring
createdAtstring
updatedAtstring
audienceIdstring
propertiesstring
unsubscribedboolean

Try it

Update a contact (properties or unsubscribed flag).

When to use

Update a contact (properties or unsubscribed flag)

Example

Ask your agent something like this:

Update a contact (properties or unsubscribed flag).

The agent will invoke mail_contact_update with these arguments:

{
  "id": "<id>",
  "audience_id": "<audience_id>"
}

Esc

Start typing to search the docs.

navigateselect