Skip to main content
POST
/
audiences
/
{audience_id}
/
contacts
JavaScript
import Surge from '@surgeapi/node';

const client = new Surge({
  apiKey: process.env['SURGE_API_KEY'], // This is the default and can be omitted
});

const contact = await client.audiences.addContact('aud_01j9a43avnfqzbjfch6pygv1td', {
  id: 'ctc_01j9dy8mdzfn3r0e8x1tbdrdrf',
});

console.log(contact.id);
{
  "email": "dom@toretto.family",
  "first_name": "Dominic",
  "id": "ctc_01j9dy8mdzfn3r0e8x1tbdrdrf",
  "last_name": "Toretto",
  "metadata": {
    "car": "1970 Dodge Charger R/T"
  },
  "phone_number": "+18015551234"
}

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.