> ## 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.

# Send a campaign mailing

> Send campaign email to recipients. The email message must be created within the Paubox Marketing web interface in order to use this to trigger a send.

**Note:** The campaign_mailing_id can be retrieved from the id= part of the URL when editing a marketing email. The subscription_list_id can be retrieved from the listId= part of the URL of any Contact List page.




## OpenAPI

````yaml openapi2 POST /campaign_mailing_sends
openapi: 3.0.3
info:
  title: Paubox Marketing API
  description: >
    Public documentation Paubox Marketing API. 


    All Paubox Marketing customers have access to the Paubox Marketing API to
    automate various tasks.


    ## Authentication

    Use the authorization header in requests with the format: `authorization:
    Token token=<API_KEY>`


    Replace `<API_KEY>` with your API key. Find your API key in the address bar
    from the email builder (note: each API Key is displayed only once upon
    creation).


    ## Base URL

    The base URL includes your username:
    `https://api.paubox.net/v1/orca/<USERNAME>`


    Replace `<USERNAME>` with your API endpoint username.
  contact:
    name: Paubox Support
    url: https://www.paubox.com
  version: 1.0.0
servers:
  - url: https://api.paubox.net/v1/orca/{username}
    description: Production server
    variables:
      username:
        description: Your API endpoint username
        default: YOUR_USERNAME
security:
  - TokenAuth: []
tags:
  - name: subscribers
    description: Subscriber management operations
  - name: analytics
    description: Campaign analytics and reporting operations
  - name: campaign_mailings
    description: Campaign mailing management and sending operations
  - name: drip_campaigns
    description: Drip campaign management and automation operations
  - name: subscription_lists
    description: Subscription list management operations
  - name: tracking_links
    description: Tracking link analytics and data operations
paths:
  /campaign_mailing_sends:
    post:
      tags:
        - campaign_mailings
      summary: Send campaign mailings
      description: >
        Send campaign email to recipients. The email message must be created
        within the Paubox Marketing web interface in order to use this to
        trigger a send.


        **Note:** The campaign_mailing_id can be retrieved from the id= part of
        the URL when editing a marketing email. The subscription_list_id can be
        retrieved from the listId= part of the URL of any Contact List page.
      operationId: sendCampaignMailing
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendCampaignMailingRequest'
            example:
              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
        required: true
      responses:
        '200':
          description: Campaign mailing sent successfully
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    SendCampaignMailingRequest:
      required:
        - campaign_mailing_id
        - campaign_mailing_send
      type: object
      properties:
        campaign_mailing_id:
          type: string
          description: >-
            UUID string, can be retrieved from the id= part of the URL when
            editing a marketing email
          format: uuid
        campaign_mailing_send:
          $ref: >-
            #/components/schemas/SendCampaignMailingRequest_campaign_mailing_send
    SendCampaignMailingRequest_campaign_mailing_send:
      required:
        - sender_email
        - subscription_list_id
      type: object
      properties:
        sender_email:
          type: string
          description: >-
            Email for a Paubox Marketing user to track who sent it. This is NOT
            the "From email" that will be used to send the message
          format: email
        subscription_list_id:
          type: string
          description: >-
            UUID string, can be retrieved from the listId= part of the URL of
            any Contact List page
          format: uuid
        recipient_emails:
          type: array
          description: >-
            Optional - will send preview message equivalent (no smart text
            replacements)
          items:
            type: string
            format: email
        customer_name:
          type: string
          description: Optional for footer. Leave empty to use default information
        from_email:
          type: string
          description: >-
            Optional - the email the user will see the email is sent from. Leave
            empty to use default information
          format: email
        from_name:
          type: string
          description: >-
            Optional - the name the user will see the email is from. Leave empty
            to use default information
        subject:
          type: string
          description: >-
            Optional - the subject of the email. Will use the marketing email
            unique ID if not specified
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
        code:
          type: string
          description: Error code
        details:
          type: object
          description: Additional error details
  responses:
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    UnprocessableEntity:
      description: Unprocessable entity
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    TokenAuth:
      type: apiKey
      description: >-
        Token-based authentication. Use format: "Token token=<API_KEY>" where
        <API_KEY> is your API key
      name: authorization
      in: header

````