Skip to main content
POST
/
campaign_mailing_sends
Send campaign mailings
curl --request POST \
  --url https://api.paubox.net/v1/orca/{username}/campaign_mailing_sends \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '
{
  "campaign_mailing_id": "g79da293-4a84-4b50-b0d9-76a16af167fe",
  "campaign_mailing_send": {
    "sender_email": "marketing@yourdomain.com",
    "subscription_list_id": "1a55ec71-0b08-457a-b183-51ac7791f1fe",
    "recipient_emails": [
      "test1@example.com",
      "test2@example.com"
    ],
    "customer_name": "Your Company",
    "from_email": "no-reply@yourdomain.com",
    "from_name": "Your Company Name",
    "subject": "Your Campaign Subject"
  }
}
'
{}

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
campaign_mailing_id
string<uuid>
required

UUID string, can be retrieved from the id= part of the URL when editing a marketing email

campaign_mailing_send
object
required

Response

Campaign mailing sent successfully

The response is of type object.