HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

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: 100

NOTE: if consented_at is provided for a double opt-in subscription, it will be ignored and the subscription will be processed without backdating.

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
Defaults to Marketing Event

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
Defaults to 01GDDKASAP8TKDDA2GRZDSVP4H

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

object
required
object
object
object
required
string
required
string
required
Defaults to Y6nRLr

The list to add the newly subscribed profiles to

Headers
string
required
Defaults to 2024-02-15

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

Responses
202

Success

Language
Credentials