Paubox Campaign Mailings API
Campaign mailing management and sending operations
Operations 8
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
“What marketing emails do I have saved in my account?”
“Can I filter my campaign emails to only those built in the HTML editor?”
Tell an agent
List my campaign mailings whose subject matches {search}.
Show campaign mailings authored with the {template_type} editor.
Ask an LLM
“How do I draft a new marketing email through the API before sending it?”
“Does a new campaign mailing need a unique subject line?”
Tell an agent
Create a new campaign mailing with {campaign_mailing}.
Save a draft marketing email for our March newsletter.
GET
/campaign_mailings/{campaign_mailing_id}
Get one campaign mailing with its content · Fetch a campaign mailing
#
Ask an LLM
“How can I see the HTML and text content of a specific campaign email?”
“Can I include the images when fetching a single marketing email?”
Tell an agent
Fetch campaign mailing {campaign_mailing_id} with its full content.
Get campaign mailing {campaign_mailing_id} including its image data ({with_images}).
PATCH
/campaign_mailings/{campaign_mailing_id}
Edit an existing campaign mailing · Update a campaign mailing
#
Ask an LLM
“How do I change the subject of a marketing email I already created?”
“Can I update only some fields of a campaign mailing and leave the rest alone?”
Tell an agent
Update campaign mailing {campaign_mailing_id} with {campaign_mailing}.
Revise the existing campaign mailing {campaign_mailing_id} to use a new subject line.
GET
/campaign_mailings/{campaign_mailing_id}/send_test_email
Send a test preview of a campaign email · Send a test email
#
Ask an LLM
“Can I send myself a preview of a campaign email to check how it renders?”
“Do test sends of a marketing email show up in my analytics?”
Tell an agent
Send a test of campaign mailing {campaign_mailing_id} to {to_email}.
Email a [Test] preview of mailing {campaign_mailing_id} to {to_email} so I can proof it.
DELETE
/campaign_mailings_bulk_delete
Permanently delete campaign mailings · Bulk delete campaign mailings
#
Ask an LLM
“How do I delete marketing emails I no longer need?”
“Is deleting a campaign mailing reversible, and does it remove its send records too?”
Tell an agent destructive · confirm first
Delete the campaign mailings {campaign_mailing_ids}.
Permanently remove marketing email {campaign_mailing_ids} and its delivery history.
Ask an LLM
“How do I trigger an immediate send of a marketing email I built in the web interface?”
“Where do I find the campaign mailing ID needed to send a campaign right away?”
Tell an agent
Send campaign mailing {campaign_mailing_id} now using {campaign_mailing_send}.
Blast marketing email {campaign_mailing_id} out immediately with send settings {campaign_mailing_send}.
POST
/campaign_mailing_schedules
Schedule a campaign email for a future time · Schedule a new campaign mailing
#
Ask an LLM
“Can I schedule a marketing email to go out at a specific date and time?”
“Does a scheduled campaign need to be sent from a verified domain?”
Tell an agent
Schedule a campaign with subject {subject} to list {subscription_list_id} at {send_at}.
Schedule {subject} for {send_at} from {from_name} <{from_email}> to list {subscription_list_id}, sent by {sender_email}.
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-schedule-campaign-mailing-request-schema.json
JSONSchema
https://artifacts.apis.io/paubox/json-schema/paubox-send-campaign-mailing-request-schema.json
JSONSchema
https://artifacts.apis.io/paubox/json-schema/paubox-campaign-mailing-write-response-schema.json
JSONSchema
https://artifacts.apis.io/paubox/json-schema/paubox-bulk-delete-campaign-mailings-request-schema.json
JSONSchema
https://artifacts.apis.io/paubox/json-schema/paubox-campaign-mailings-response-schema.json
JSONSchema
https://artifacts.apis.io/paubox/json-schema/paubox-create-campaign-mailing-request-schema.json