Operations 7
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
“Who are the contacts in my marketing audience?”
“Can I list only the subscribers on a particular contact list?”
Tell an agent
List subscribers on list {subscription_list_id}.
Search my subscribers for {search}.
Ask an LLM
“How do I add one new contact to my marketing audience?”
“Can I add a new subscriber directly to a specific list when I create them?”
Tell an agent
Create subscriber {subscriber}.
Add new subscriber {subscriber} to list {subscription_list_id}.
Ask an LLM
“How do I look up a single subscriber's record?”
“Can I see a subscriber's engagement stats along with their profile?”
Tell an agent
Get subscriber {subscriber_id}.
Show subscriber {subscriber_id} with aggregate analytics ({with_stats}).
Ask an LLM
“How do I overwrite a subscriber's record using a PUT request?”
“Is there a PUT variant for updating a subscriber?”
Tell an agent
PUT updated details {subscriber} onto subscriber {subscriber_id}.
Use the PUT endpoint to update subscriber {subscriber_id}.
Ask an LLM
“Can I change just a subscriber's name with a PATCH request?”
“Which method lets me patch a few fields on a contact?”
Tell an agent
PATCH subscriber {subscriber_id} with {subscriber}.
Patch only the changed fields on subscriber {subscriber_id}.
Ask an LLM
“Can I import a batch of contacts in a single request?”
“How do I bulk add subscribers straight onto one list?”
Tell an agent
Bulk create these subscribers: {subscribers}.
Import {subscribers} into list {subscription_list_id} in one go.
Ask an LLM
“How do I delete several subscribers at once?”
“Can I remove subscribers from one list only rather than from all contacts?”
Tell an agent destructive · confirm first
Delete subscribers {subscriber_ids}.
Remove subscribers {subscriber_ids} from list {subscription_list_id}.
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-create-subscribers-request-schema.json
JSONSchema
https://artifacts.apis.io/paubox/json-schema/paubox-create-subscriber-request-schema.json
JSONSchema
https://artifacts.apis.io/paubox/json-schema/paubox-update-subscriber-request-schema.json
JSONSchema
https://artifacts.apis.io/paubox/json-schema/paubox-subscribers-response-schema.json
JSONSchema
https://artifacts.apis.io/paubox/json-schema/paubox-bulk-create-response-schema.json
JSONSchema
https://artifacts.apis.io/paubox/json-schema/paubox-detailed-subscriber-response-schema.json