Paubox Subscriptions API
Subscriber opt-in and opt-out operations
Operations 10
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“How do I see every subscriber-to-list membership in my account?”
“Which list-level opt-outs exist across my subscriptions?”
Tell an agent
List all subscriptions on my account.
Show every subscription record with its unsubscribed_at timestamp.
Ask an LLM
“How do I put an existing subscriber onto a list using their internal numeric ID?”
“Will creating a subscription trigger a drip campaign on that list?”
Tell an agent
Create subscription {subscription}.
Create a subscription record linking a numeric subscriber ID to a list: {subscription}.
Ask an LLM
“How do I look up a single subscription by its UUID?”
“Can I check whether one specific list membership has been unsubscribed?”
Tell an agent
Get subscription {subscription_id}.
Show the details of list membership {subscription_id}.
DELETE
/subscriptions/{subscription_id}
Unsubscribe one list membership · Unsubscribe a subscription
#
Ask an LLM
“How do I unsubscribe someone from just one list using the subscription's UUID?”
“Does removing a single subscription opt the person out globally?”
Tell an agent destructive · confirm first
Unsubscribe subscription {subscription_id}.
End list membership {subscription_id} without touching their other lists.
Ask an LLM
“How do I re-subscribe a few contacts who previously opted out?”
“Can I clear opt-outs on specific lists only for certain subscribers?”
Tell an agent
Re-subscribe subscribers {subscriber_ids}.
Re-subscribe {subscriber_ids} to lists {subscription_list_ids}.
POST
/subscriptions/unsubscribe
Unsubscribe or opt out specific subscribers · Unsubscribe subscribers
#
Ask an LLM
“How do I unsubscribe a handful of contacts by their UUIDs?”
“What happens if I unsubscribe subscribers without naming any lists?”
Tell an agent destructive · confirm first
Globally opt out subscribers {subscriber_ids}.
Unsubscribe {subscriber_ids} from lists {subscription_list_ids} only.
POST
/subscriptions/bulk_global_subscribe
Clear global opt-out for a whole list · Bulk global subscribe
#
Ask an LLM
“Can I clear the global opt-out for everyone on a subscription list without listing each one?”
“Can I re-subscribe a whole list except a few people?”
Tell an agent
Clear the global opt-out for everyone on subscription list {from_subscription_list_id}.
Globally re-subscribe all of list {from_subscription_list_id} except {except_ids}.
POST
/subscriptions/bulk_global_unsubscribe
Globally opt out a whole subscription list · Bulk global unsubscribe
#
Ask an LLM
“How do I globally opt out every member of a subscription list in one call?”
“Can I suppress marketing email for a list's members matching a search term?”
Tell an agent destructive · confirm first
Globally opt out every subscriber on list {from_subscription_list_id}.
Opt out members of list {from_subscription_list_id} matching {search}, except {except_ids}.
POST
/subscriptions/dynamic_bulk_subscribe
Clear global opt-out for a dynamic list · Bulk subscribe a dynamic list
#
Ask an LLM
“Can I re-subscribe everyone who currently matches a dynamic list's filters?”
“How do I clear opt-outs for a saved dynamic segment in the background?”
Tell an agent
Clear the global opt-out for all current members of dynamic list {from_subscription_list_id}.
Re-subscribe dynamic list {from_subscription_list_id} except {except_ids}.
POST
/subscriptions/dynamic_bulk_unsubscribe
Globally opt out a dynamic list's members · Bulk unsubscribe a dynamic list
#
Ask an LLM
“How do I opt out everyone currently in a dynamic list segment?”
“Can I unsubscribe a dynamic list's members but spare a few of them?”
Tell an agent destructive · confirm first
Globally opt out all current members of dynamic list {from_subscription_list_id}.
Unsubscribe dynamic segment {from_subscription_list_id}, sparing {except_ids}.
Documentation
Documentation
https://docs.paubox.com/email-api
GettingStarted
https://docs.paubox.com/email-api/quickstart
Authentication
https://docs.paubox.com/email-api/authentication
Documentation
https://docs.paubox.com/marketing
Documentation
https://docs.paubox.com/forms/index
Authentication
https://docs.paubox.com/forms/authentication
Specifications
Schemas & Data
JSONSchema
https://artifacts.apis.io/paubox/json-schema/paubox-bulk-subscription-change-request-schema.json
JSONSchema
https://artifacts.apis.io/paubox/json-schema/paubox-subscription-change-request-schema.json
JSONSchema
https://artifacts.apis.io/paubox/json-schema/paubox-bulk-subscription-change-response-schema.json
JSONSchema
https://artifacts.apis.io/paubox/json-schema/paubox-subscription-change-response-schema.json
JSONSchema
https://artifacts.apis.io/paubox/json-schema/paubox-create-subscription-response-schema.json
JSONSchema
https://artifacts.apis.io/paubox/json-schema/paubox-create-subscription-request-schema.json