HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference
These docs are for a deprecated API version. Click here to use the latest version.

Subscribe Profiles

Subscribe one or more profiles to email marketing, SMS marketing, or both. If the 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.
To add someone to a list without changing their subscription status, use Add Profile to List.
Maximum number of profile can be submitted for subscription: 100

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

Scopes:
List 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
required
Defaults to Y6nRLr

The list to add the newly subscribed profiles to

string
Defaults to Marketing Event

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

array of objects
required

One or more subscriptions to be created.

subscriptions*
object

When provided, this will provide consent for the indicated message types on the specified channels. If omitted, we will subscribe the profile to all message types on the channels corresponding to the provided identifiers.

string
Defaults to matt-kemp@klaviyo-demo.com

The email address to subscribe or to set on the profile if channels is specified and the email channel is omitted.

string
Defaults to +15005550006

The phone number to subscribe or to set on the profile if channels is specified and the SMS channel is omitted.

string
Defaults to 01GDDKASAP8TKDDA2GRZDSVP4H

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

Headers
string
required
Defaults to 2023-01-24

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

Responses
202

Language
Credentials