Deprecated | Add or update audience member

POST

/api/v2/channels/{{channel}}/audience

Deprecation notice: this endpoint has been deprecated in favor of the top-level api/v2/audience endpoint, which allows developers to manage audience members across an entire organization. This endpoint will remain available, but its features will stay limited.

You can add a new or update an existing subscriber with an email address - in a limited fashion. Right now, we only let you change their subscription status and name, but we will introduce new properties soon. Please let us know what you’d like to see.

Note: the /subscribers example below can be used as an alias to /audience . You may have seen references to such an endpoint. It still exists in v2, we just prefer to use a more general “audience” term to reflect people who might not technically be subscribers to a newsletter.

Authorizations

• bearerAuth

Parameters

Path Parameters

channel

required

string

Request Body

Media type multipart/form-data

object

channelSubscriberStatus

Your subscriber’s subscription status is represented by a number (we know, not super intuitive …). Our api will reject attempts to subscribe a person who has been unsubscribed or bounced.

Status	Value
Not subscribed	0
Subscribed	1
Unsubscribed	2
Bounced	3
Pending confirmation	4

string

Example

0

email

The full, qualified email address of your new or existing subscriber. We use this to identify them: if we can’t find a match, we’ll add your person; otherwise, we’ll update them - everything but the email itself.

string

Example

[email protected]

name

Your subscriber’s name. You can pass an empty value, but you must pass the key.

string

Example

Noodle the Pug II

Responses

200

Update existing / Update existing - “subscribers” endpoint

Media type text/plain

Examples

{
    "channelSubscriberStatus": 0,
    "email": "[email protected]",
    "name": "Noodle the Pug II",
    "updatedAt": "2021-10-21 01:54:20",
}

{
    "channelSubscriberStatus": 0,
    "email": "[email protected]",
    "name": "Noodle the Pug II",
    "updatedAt": "2021-10-21 01:54:20",
}

Headers

Access-Control-Allow-Credentials

string

Example

true

Access-Control-Allow-Origin

string

Example

*

Access-Control-Max-Age

string

Example

86400

Cache-Control

string

Example

no-cache, private

Connection

string

Example

keep-alive

Date

string

Example

Thu, 21 Oct 2021 01:54:20 GMT

Server

string

Example

nginx/1.14.0 (Ubuntu)

Transfer-Encoding

string

Example

chunked

201

Adding new

Media type text/plain

Examples

Example Adding new

{
    "channelSubscriberStatus": 4,
    "createdAt": "2021-10-21 01:51:30",
    "email": "[email protected]",
    "name": "Noodle the Pug",
    "updatedAt": "2021-10-21 01:51:30",
}

Headers

Access-Control-Allow-Credentials

string

Example

true

Access-Control-Allow-Origin

string

Example

*

Access-Control-Max-Age

string

Example

86400

Cache-Control

string

Example

no-cache, private

Connection

string

Example

keep-alive

Date

string

Example

Thu, 21 Oct 2021 01:51:30 GMT

Server

string

Example

nginx/1.14.0 (Ubuntu)

Transfer-Encoding

string

Example

chunked