HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Bulk Subscribe Profiles

Subscribe one or more profiles to email marketing, SMS marketing, or both. If the provided list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message.
Learn more about consent in this guide.

If a list is not provided, the opt-in process used will be determined by the account-level default opt-in setting.

To add someone to a list without changing their subscription status, use Add Profile to List.

This API will remove any UNSUBSCRIBE, SPAM_REPORT or USER_SUPPRESSED suppressions from the provided profiles. Learn more about suppressed profiles.

Maximum number of profiles can be submitted for subscription: 1000

This endpoint now supports a historical_import flag. If this flag is set true, profiles being subscribed will bypass double opt-in emails and be subscribed immediately. They will also bypass any associated "Added to list" flows. This is useful for importing historical data where you have already collected consent. If historical_import is set to true, the consented_at field is required and must be in the past.

Rate limits:
Burst: 75/s
Steady: 700/m

Scopes:
lists:write
profiles:write
subscriptions:write

Body Params

Subscribes one or more profiles to marketing. Currently, supports email and SMS only. All profiles will be added to the provided list. Either email or phone number is required. Both may be specified to subscribe to both channels.
If a profile cannot be found matching the given identifier(s), a new profile will be created and then subscribed.

object
required
string
required
object
required
string

A custom method detail or source to store on the consent records.

object
required

The profile(s) to subscribe

array of objects
required
data*
string
required
string

The ID of the profile to subscribe. If provided, this will be used to perform the lookup.

object
required
boolean
Defaults to false

Whether this subscription is part of a historical import. If true, the consented_at field must be provided for each profile.

object
object
object
string
required
string
required

The list to add the newly subscribed profiles to

Headers
string
required
Defaults to 2025-01-15

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses
202

Success

Language
Credentials