HomeTutorialsAPI ReferenceStatus
API Reference

Create Subscription via Element (with challenge) - Public

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

Same as /o/subscribe but also runs the configured challenge provider (hCaptcha/reCAPTCHA). Provide challenge_token and challenge_action.

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.

string
required

Token from the configured challenge provider.

string
required

Action name associated with the challenge.

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').

Responses
201

The created subscription.

422

Challenge validation failed.

Updated about 3 hours ago

Language
URL
LoadingLoading…

Updated about 3 hours ago