HomeTutorialsAPI ReferenceStatus
API Reference

Create Subscription - Public

post
https://{APP_DOMAIN}/api/3.2/o/subscribe

Creates a subscription on a publication for a visitor. Spam checks run before creation; spam signups return a bogus 201. Unrecognised form fields are saved as subscriber variables. Use enable_addon=SMS with phone to attach an SMS addon. Use segment_ids to also add the subscriber to specific segments.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Body Params

string
required

Subscriber email address.

integer
required

The publication to subscribe to.

integer

Optional marketing effort that attributed this signup.

segment_ids
array of integers

Optional segment IDs to add the subscriber to after creation.

segment_ids
string
enum

Optional addon to enable. Currently only 'SMS' is supported.

Allowed:
string

Phone number (required when enable_addon is 'SMS').

boolean

When true, requires that the subscriber already has an active subscription on the publication (used for paid publication signup flows). The endpoint returns 422 if no active subscription exists.

Responses
201

The created subscription (or a no-op response for flagged spam signups).

422

Challenge validation failed, or the visitor was required to have an existing active subscription.

Updated about 3 hours ago

Language
URL
LoadingLoading…

Updated about 3 hours ago