Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

audience_id
string
required

The audience ID to add the contact to.

Example:

"aud_01j9a43avnfqzbjfch6pygv1td"

Body

application/json

Params for adding an existing contact to a manual audience

id
string
required

The ID of the contact to add. The contact must belong to the same account as the audience.

Response

The contact, now a member of the audience

A contact who has consented to receive messages

id
string
required

Unique identifier for the object.

phone_number
string<phone-number>
required

The contact's phone number in E.164 format.

Pattern: ^\+[1-9]\d{6,14}$
Example:

"+18015551234"

email
string<email>

The contact's email address.

first_name
string

The contact's first name.

last_name
string

The contact's last name.

metadata
Metadata · object

Set of key-value pairs that will be stored with the object.