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

# Overview

> Base URL, authentication, and conventions for the Paubox Marketing API.

## Base URL

`https://api.paubox.net/v1/orca/YOUR_USERNAME`

Replace `YOUR_USERNAME` with your API endpoint username.

## Authorization

Include an `Authorization` header with every request:

`Authorization: Token token=YOUR_API_KEY`

Replace `YOUR_API_KEY` with your API key. Generate your key on the [Paubox Marketing > Settings](https://next.paubox.com/marketing/settings) page (note: each API key is displayed only once upon creation):

<Frame>
  ![](https://docs.paubox.com/services/api/attachments/07715022-3347-4753-9125-2418540efb57)
</Frame>

## Example call

```bash theme={null}
curl -X POST \
  https://api.paubox.net/v1/orca/YOUR_USERNAME/subscribers \
  -H 'Authorization: Token token=YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "subscriber": {
      "email": "recipient@example.com",
      "first_name": "Jane",
      "last_name": "Smith"
    }
  }'
```

## Date format

Dates are passed as ISO8601 strings with UTC timezone

## Finding id parameters for subscription\_list\_id, campaign\_mailing\_id, etc.

<CardGroup>
  <Card title="Finding parameter values in the web dashboard" icon="file-text" href="/marketing/parameter-values" horizontal />
</CardGroup>

## Community & support

<CardGroup cols={2}>
  <Card title="Q&A" icon="comments" href="https://github.com/Paubox/community/discussions/categories/paubox-marketing">
    Ask usage questions in the Paubox Community.
  </Card>

  <Card title="Ideas" icon="lightbulb" href="https://github.com/Paubox/community/discussions/categories/ideas">
    Propose features and improvements.
  </Card>
</CardGroup>

<Warning>
  Never post PHI, recipient addresses, or message content in public threads. Account, billing, or anything sensitive goes to [support@paubox.com](mailto:support@paubox.com).
</Warning>