HomeTutorialsAPI ReferenceStatus
API Reference

Create Subscription

post
https://{APP_DOMAIN}/api/3.2/subscriptions

Creates a subscription (subscribes an email to a publication). The email is validated for spam and deliverability before creating. Set lead to true to create a lead instead of an active subscription.

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

Body Params

string
required

The email for the subscription.

integer
required

The publication ID that the subscription will be created on.

integer

The id of the subscriber who the subscription should be associated with. If left blank, OptiPub will automatically associate this subscription with a subscriber who shares the email.

integer

An optional source effort id to attribute to the subscription.

boolean

Provide this optional boolean to create a lead instead of an active subscription.

string

The IP address that the subscription was started from.

variables
array of strings

The variables to save with the subscription. These variables must exist within your variables configuration page.

variables
tag_ids
array of integers

Array of tag ids to associate with subscription

tag_ids
string

Comma-separated list of case-sensitive tag names to add to the subscription

string

Comma-separated list of case-sensitive tag names to remove from the subscription

Response

Updated 25 days ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 25 days ago