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

# Create a subscriber

> Creates a subscriber record. Adds record to subscription list if specified otherwise adds to all contacts.

**Example curl command:**
```bash
curl -X POST \
https://api.paubox.net/v1/orca/<USERNAME>/subscribers \
  -H 'authorization: Token token=<API_KEY>' \
  -H 'content-type: application/json' \
  -d '{
    "subscriber": {
        "email": "test@example.com",
        "first_name": "test",
        "last_name": "example"
    }
  }'
```




## OpenAPI

````yaml openapi2 POST /subscribers
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:
  /subscribers:
    post:
      tags:
        - subscribers
      summary: Create subscriber
      description: >
        Creates a subscriber record. Adds record to subscription list if
        specified otherwise adds to all contacts.


        **Example curl command:**

        ```bash

        curl -X POST \

        https://api.paubox.net/v1/orca/<USERNAME>/subscribers \
          -H 'authorization: Token token=<API_KEY>' \
          -H 'content-type: application/json' \
          -d '{
            "subscriber": {
                "email": "test@example.com",
                "first_name": "test",
                "last_name": "example"
            }
          }'
        ```
      operationId: createSubscriber
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSubscriberRequest'
            example:
              subscriber:
                email: test@example.com
                first_name: test
                last_name: example
        required: true
      responses:
        '200':
          description: Subscriber created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriberResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    CreateSubscriberRequest:
      type: object
      properties:
        subscriber:
          $ref: '#/components/schemas/CreateSubscriberRequest_subscriber'
        subscription_list_id:
          type: string
          description: Optional subscription list ID
    SubscriberResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Subscriber'
    CreateSubscriberRequest_subscriber:
      type: object
      properties:
        email:
          type: string
          description: >-
            Subscriber's email address (required unless phone_number is
            provided)
          format: email
        phone_number:
          type: string
          description: E.164 formatted phone number (required unless email is provided)
        first_name:
          type: string
          description: Subscriber's first name
        last_name:
          type: string
          description: Subscriber's last name
        custom_fields:
          type: array
          description: Optional custom fields (unlimited)
          items:
            type: object
            additionalProperties:
              type: string
    Subscriber:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the subscriber
        type:
          type: string
          description: Resource type
          enum:
            - subscriber
        attributes:
          $ref: '#/components/schemas/Subscriber_attributes'
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
        code:
          type: string
          description: Error code
        details:
          type: object
          description: Additional error details
    Subscriber_attributes:
      required:
        - email
        - unsubscribed
      type: object
      properties:
        email:
          type: string
          description: Subscriber's email address
          format: email
        first_name:
          type: string
          description: Subscriber's first name
        last_name:
          type: string
          description: Subscriber's last name
        unsubscribed:
          type: boolean
          description: Whether the subscriber is unsubscribed
  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

````