Update Subscription

put

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

Updates a subscription. Setting active to true reactivates, false unsubscribes. Updating the email will migrate the subscription to the new email address.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

The id of the Subscription

Body Params

string

The email for the subscription. When provided, the subscription is migrated to this email (can fail with 422).

subscriber_id

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.

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

active

boolean

Whether the subscription should be active or not.

tag_ids

array of integers

Array of tag ids to associate with subscription

tag_ids

add_tags_by_name

string

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

remove_tags_by_name

string

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

Responses

422

Email migration failed (e.g. the target email already has a conflicting subscription).

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

200The updated subscription