> ## Documentation Index
> Fetch the complete documentation index at: https://developers.benchmarkemail.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Add a campaign



## OpenAPI

````yaml /openapi.json post /api/email/campaign
openapi: 3.0.0
info:
  description: >-
    Public REST API for Benchmark Email.


    Authenticate every request by including your API key in the `X-API-Key`
    header.

    Each key is issued with one or more scopes that control which endpoints it
    may call.


    Rate limits: 60 requests per minute per account.

    Monthly quota: determined by your subscription plan.
  title: Benchmark Email API
  version: 1.0.0
servers:
  - description: >-
      Your account's API base URL. Copy the full URL shown on Settings > API
      Keys in your Benchmark Email account and paste it here.
    url: '{apiBaseUrl}'
    variables:
      apiBaseUrl:
        default: ''
        description: >-
          Your account's API base URL. Copy it from Settings > API Keys in your
          Benchmark Email account.
security:
  - apiKeyAuth: []
tags:
  - description: Contact related endpoints
    name: contact
  - description: Contact structure related endpoints
    name: contact-structure
  - description: List related endpoints
    name: lists
  - description: Email domain related endpoints
    name: email-domain
  - description: Email campaign related endpoints
    name: email-campaign
  - description: Email template related endpoints
    name: email-template
  - description: Report related endpoints
    name: reports
paths:
  /api/email/campaign:
    post:
      tags:
        - email-campaign
      summary: Add a campaign
      operationId: post_api_email_campaign
      requestBody:
        content:
          application/json: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  _id:
                    description: Id of the campaign
                    type: string
                  cancelledAt:
                    description: Timestamp when the campaign was cancelled or failed
                    nullable: true
                    type: string
                  createdAt:
                    description: Date and time of creation
                    type: string
                  failedCount:
                    description: Failed sent count
                    type: number
                  previewImageUrl:
                    description: Email Preview Image Url
                    type: string
                  scheduledAt:
                    description: Date and time of scheduled email
                    type: string
                  sentCount:
                    description: Successfully sent count
                    type: number
                  status:
                    description: Status of the campaign
                    type: string
                  subStatus:
                    description: >-
                      Granular failure/cancellation reason. Null for non-failure
                      states or legacy campaigns.
                    enum:
                      - null
                    nullable: true
                    type: string
                  totalRecipients:
                    description: Total email recipients
                    type: number
                  updatedAt:
                    description: Date and time of last update
                    type: string
                type: object
          description: Successfully created
        '400':
          description: Bad request
        '401':
          description: Unauthorized
      security:
        - apiKeyAuth: []
components:
  securitySchemes:
    apiKeyAuth:
      description: API key authentication
      in: header
      name: X-API-Key
      type: apiKey

````