Skip to main content
POST
/
campaign_mailing_schedules
Schedule a new campaign mailing
curl --request POST \
  --url https://api.paubox.net/v1/orca/{username}/campaign_mailing_schedules \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '
{
  "send_at": "2023-05-01T15:00:00Z",
  "from_email": "no-reply@yourdomain.com",
  "from_name": "Your Company Name",
  "sender_email": "marketing@yourdomain.com",
  "subscription_list_id": "123e4567-e89b-12d3-a456-426614174000",
  "subject": "Your Campaign Subject Line",
  "dynamic_list_id": "optional-uuid-for-dynamic-list",
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
'
{
  "data": {
    "send_at": "2023-11-07T05:31:56Z",
    "send_at_timestamp": "<string>",
    "jid": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.paubox.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
authorization
string
header
required

Token-based authentication. Use format: "Token token=<API_KEY>" where <API_KEY> is your API key

Body

application/json
​
send_at
string<date-time>
required

The time at which to send the campaign, in RFC3339 format

​
from_email
string<email>
required

The email address from which the campaign will be sent. It should be from a verified domain from your Paubox Marketing settings page

​
from_name
string
required

The name to appear as the sender of the campaign

​
sender_email
string<email>
required

The email address of the person/entity sending this email. Should be a Paubox user email address and is NOT going to appear as the From email

​
subscription_list_id
string<uuid>
required

The uuid of the subscription list to which the campaign will be sent

​
subject
string
required

The subject line of the campaign mailing

​
dynamic_list_id
string<uuid>

The uuid of the dynamic list to which the campaign will be sent (optional)

​
recipient_emails
string<email>[]

A list of extra recipient email addresses for the campaign to be sent to. These are not tracked for analytics purposes and are usually just for verification and/or testing

Response

Campaign mailing scheduled successfully

​
data
object