Bulk create subscribers

Using this endpoint you can create multiple subscribers at once, to avoid multiple calls to the API. The bulk API is limited to 500 subscribers per request.

Authorizations

Authorization

string

header

required

API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".

Headers

idempotency-key

string

A header for idempotency purposes

Body

application/json

subscribers

object[]

required

An array of subscribers to be created in bulk.

Show child attributes

subscribers.subscriberId

string

required

The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems

subscribers.avatar

string

An HTTP URL to the profile image of your subscriber.

subscribers.channels

object[]

An optional array of subscriber channels.

Show child attributes

subscribers.channels.credentials

object

required

Credentials for the channel.

Show child attributes

subscribers.channels.credentials.deviceTokens

string[]

An array of device tokens for push notifications.

subscribers.channels.credentials.webhookUrl

string

The URL for the webhook associated with the channel.

subscribers.channels.providerId

enum<string>

required

The ID of the chat or push provider.

Available options:

slack,

discord,

msteams,

mattermost,

ryver,

zulip,

grafana-on-call,

getstream,

rocket-chat,

whatsapp-business,

fcm,

apns,

expo,

one-signal,

pushpad,

push-webhook,

pusher-beams

subscribers.channels.integrationIdentifier

string

An optional identifier for the integration.

subscribers.data

object

An optional payload object that can contain any properties.

Show child attributes

subscribers.data.{key}

subscribers.email

string

The email address of the subscriber.

subscribers.firstName

string

The first name of the subscriber.

subscribers.lastName

string

The last name of the subscriber.

subscribers.locale

string

The locale of the subscriber.

subscribers.phone

string

The phone number of the subscriber.

Response

201 - application/json

created

object[]

required

An array of subscribers that were successfully created.

Show child attributes

created.subscriberId

string

required

The ID of the subscriber that was created.

failed

object[]

required

An array of failed operations with error messages and optional subscriber IDs.

Show child attributes

failed.message

string

The error message associated with the failed operation.

failed.subscriberId

string

The subscriber ID associated with the failed operation. This field is optional.

updated

object[]

required

An array of subscribers that were successfully updated.

Show child attributes

updated.subscriberId

string

required

The ID of the subscriber that was updated.