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

Create Client Subscription

Create a new subscription for the given list ID and channel:

  • Email email
  • SMS phone_number

This endpoint is specifically designed to be called from publicly-browseable, client-side environments only. To create subscriptions from server-based applications, please use POST /api/profile-subscription-bulk-create-jobs

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

Scopes:
subscriptions:write

Query Params
string
required
Defaults to PUBLIC_API_KEY

Your Public API Key / Site ID. See this article for more details.

Body Params

Creates a subscription and consent records 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. To create a subscription and consent record for only one 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.

data
object
required
Headers
string
required
Defaults to 2023-02-22

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

Response
202
Language