Paubox

Paubox Subscription Lists API

Subscription list management operations

GitHub OpenAPI
Business capability
Digital Marketing Management BC-400.60

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /subscription_lists List contact lists · Fetch subscription lists #
Ask an LLM
“What subscription lists do I have in my marketing account?”
“How can I get the IDs of all my contact lists?”
Tell an agent
List all my subscription lists.
Show every contact list with its ID.
POST /subscription_lists Create a contact list · Create subscription list #
Ask an LLM
“How do I create a new contact list for segmenting subscribers?”
“Are there names I'm not allowed to use for a new subscription list?”
Tell an agent
Create a subscription list called {name}.
Make a new contact list named {name}.
PUT /subscription_lists/{subscription_list_id} Rename a contact list (PUT) · Update subscription list #
Ask an LLM
“How do I rename a subscription list with a PUT request?”
“Is there a PUT method for changing a contact list's name?”
Tell an agent
PUT the name {name} on subscription list {subscription_list_id}.
Use the PUT endpoint to rename list {subscription_list_id} to {name}.
DELETE /subscription_lists/{subscription_list_id} Delete a contact list · Delete subscription list #
Ask an LLM
“How do I delete a subscription list I no longer need?”
“Can the default all-contacts list be deleted?”
Tell an agent destructive · confirm first
Delete subscription list {subscription_list_id}.
Remove contact list {subscription_list_id} from the account.
PATCH /subscription_lists/{subscription_list_id} Rename a contact list (PATCH) · Update subscription list #
Ask an LLM
“Can I patch a subscription list's name instead of using PUT?”
“Which PATCH call changes what a contact list is called?”
Tell an agent
PATCH subscription list {subscription_list_id} with the name {name}.
Patch contact list {subscription_list_id} so it's called {name}.

Documentation

📖
Documentation
https://docs.paubox.com/email-api
📖
GettingStarted
https://docs.paubox.com/email-api/quickstart
📖
Authentication
https://docs.paubox.com/email-api/authentication
📖
Documentation
https://docs.paubox.com/marketing
📖
Documentation
https://docs.paubox.com/forms/index
📖
Authentication
https://docs.paubox.com/forms/authentication

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/paubox/refs/heads/main/openapi/paubox-subscription-lists-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/paubox/refs/heads/main/json-schema/paubox-create-subscription-list-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/paubox/refs/heads/main/json-schema/paubox-subscription-lists-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/paubox/refs/heads/main/json-schema/paubox-update-subscription-list-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/paubox/refs/heads/main/json-schema/paubox-subscription-list-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/paubox:paubox-subscription-lists-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

paubox-subscription-lists-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Paubox Marketing Subscription Lists 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=`


    Replace `` 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

    `https://api.paubox.com/v1/marketing`'
  contact:
    name: Paubox Support
    url: https://www.paubox.com
  version: 1.0.0
servers:
- url: https://api.paubox.com/v1/marketing
  description: Production server
security:
- TokenAuth: []
tags:
- name: Subscription Lists
  description: Subscription list management operations
paths:
  /subscription_lists:
    get:
      tags:
      - Subscription Lists
      summary: Fetch subscription lists
      description: Return json data about subscription lists
      operationId: getSubscriptionLists
      responses:
        '200':
          description: Subscription lists data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionListsResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
    post:
      tags:
      - Subscription Lists
      summary: Create subscription list
      description: Creates a subscription list record
      operationId: createSubscriptionList
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSubscriptionListRequest'
            example:
              name: Newsletter Subscribers
        required: true
      responses:
        '200':
          description: Subscription list created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionListResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /subscription_lists/{subscription_list_id}:
    put:
      tags:
      - Subscription Lists
      summary: Update subscription list
      description: Updates a subscription list record
      operationId: updateSubscriptionListPut
      parameters:
      - name: subscription_list_id
        in: path
        description: The ID of the subscription list to update
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSubscriptionListRequest'
            example:
              name: Updated Newsletter Subscribers
        required: true
      responses:
        '200':
          description: Subscription list updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionListResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      tags:
      - Subscription Lists
      summary: Delete subscription list
      description: 'Deletes subscription list record.


        **Note:** Cannot delete default/all contacts list.'
      operationId: deleteSubscriptionList
      parameters:
      - name: subscription_list_id
        in: path
        description: The ID of the subscription list to delete
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Subscription list deleted successfully
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '500':
          $ref: '#/components/responses/InternalServerError'
    patch:
      tags:
      - Subscription Lists
      summary: Update subscription list
      description: Updates a subscription list record
      operationId: updateSubscriptionListPatch
      parameters:
      - name: subscription_list_id
        in: path
        description: The ID of the subscription list to update
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSubscriptionListRequest'
            example:
              name: Updated Newsletter Subscribers
        required: true
      responses:
        '200':
          description: Subscription list updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionListResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Bad request
      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'
  schemas:
    SubscriptionListsResponse_data:
      type: object
      properties:
        id:
          type: string
          description: Subscription list ID
        type:
          type: string
          description: Resource type
          enum:
          - subscription_list
        attributes:
          $ref: '#/components/schemas/SubscriptionListsResponse_attributes'
    SubscriptionListsResponse_attributes:
      type: object
      properties:
        name:
          type: string
          description: Name of the subscription list
        is_default:
          type: boolean
          description: Whether this is the default subscription list
        subscriber_count:
          type: integer
          description: Number of subscribers in this list
        form_id:
          type: string
          description: Form ID for use with Paubox Secure Forms
    SubscriptionListsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionListsResponse_data'
    SubscriptionListResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SubscriptionListsResponse_data'
    UpdateSubscriptionListRequest:
      required:
      - name
      type: object
      properties:
        name:
          type: string
          description: Name of the subscription list
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
        code:
          type: string
          description: Error code
        details:
          type: object
          description: Additional error details
    CreateSubscriptionListRequest:
      required:
      - name
      type: object
      properties:
        name:
          type: string
          description: Name of the subscription list (cannot be 'default')
  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