HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Create Client Subscription

Creates a subscription and consent record for email and/or SMS channels based on the provided email and phone_number attributes, respectively. One of either email or phone_number must be provided.

This endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a public API key (site ID). Never use a private API key with our client-side endpoints.

To subscribe profiles from server-side applications, please use POST /api/profile-subscription-bulk-create-jobs.

To create a subscription and consent record for only 1 channel but still include the other channel as a profile property, the consent channel can be provided as a top-level attribute and the other channel can be included in the properties object.

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

Scopes:
subscriptions:write

Language