Skip to content

Mail

mail_contact_create

Add a contact to an audience

Tool

mail_contact_create

Add a contact to an audience

Add a contact to an audience

Behavior

HTTP
POST /mail/audiences/:audienceId/contacts

Arguments

NameTypeRequiredDescription
emailstringContact email address
propertiesobjectCustom key/value properties (e.g. first_name, last_name)
audience_idstringAudience the contact belongs to
unsubscribedbooleanMarketing opt-out flag

Response

FieldTypeAlwaysDescription
idstring
emailstring
createdAtstring
updatedAtstring
audienceIdstring
propertiesstring
unsubscribedboolean

Try it

Add a contact to an audience.

When to use

Add a contact to an audience

Example

Ask your agent something like this:

Add a contact to an audience.

The agent will invoke mail_contact_create with these arguments:

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

Esc

Start typing to search the docs.

navigateselect