Create Subscription - Public

post

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

Creates a subscription on a publication for a visitor. This endpoint runs no bot challenge and can be switched off under Settings → Bot Protection (Allow subscriptions through the public API); when off it returns 403. 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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

string

required

Subscriber email address.

publication_id

integer

required

The publication to subscribe to.

effort_id

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

enable_addon

string

enum

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

Allowed:

phone

string

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

existing_subscription

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.

locale

string

Optional subscriber language preference (for example de or en-US). Stored on the email address, shared by every subscription that address holds; not saved as a subscriber variable.

timezone

string

Optional subscriber IANA timezone (for example America/New_York). Stored on the email address, shared by every subscription that address holds; not saved as a subscriber variable.

Responses

201

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

403

The public subscribe API is disabled for this installation.

422

The visitor was required to have an existing active subscription.