---
title: "Create a subscriber export job"
method: POST
path: "/v1/jobs/subscriber-exports"
tags: ["Jobs"]
---

# Create a subscriber export job

`POST /v1/jobs/subscriber-exports`

## Request

- Base URL: `https://api.mailrith.com`
- URL: `https://api.mailrith.com/v1/jobs/subscriber-exports`
- Auth: HTTP bearer

Queues an asynchronous Subscriber export for the authenticated workspace. Requires `subscribers:export` because the finished file contains bulk Subscriber data.

## Headers

- `Idempotency-Key` string

## Request body

- SubscriberExportJobCreateRequest
  - `query` string, nullable
  - `status` 'Active' | 'Unconfirmed' | 'Unsubscribed' | 'Complained' | 'Bounced' | 'Blocked' | 'null', nullable
  - `cold_only` boolean

## Response `202`

The export job was queued.

- object
  - `data` SubscriberExportJob, required
    - `self` string, required: Stable relative Public API path for retrieving this resource.
    - `id` string, required
    - `status` 'Queued' | 'Processing' | 'Completed' | 'Failed', required
    - `selection` object, required
      - `query` string, nullable, required
      - `status` 'Active' | 'Unconfirmed' | 'Unsubscribed' | 'Complained' | 'Bounced' | 'Blocked' | 'null', nullable, required
      - `cold_only` boolean, required
    - `exported_count` integer, nullable, required
    - `file_name` string, nullable, required
    - `download_url` string, nullable, required
    - `expires_at` string, date-time, nullable, required
    - `error_message` string, nullable, required
    - `started_at` string, date-time, nullable, required
    - `completed_at` string, date-time, nullable, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required

## Other responses

- `400`: The request is invalid.

---

[API](https://skmtc.dev/mailrith/apis/mailrith-api.md) · [All operations](https://skmtc.dev/mailrith/apis/mailrith-api/llms.txt) · [OpenAPI document](https://skmtc.dev/mailrith/apis/mailrith-api/revisions/41f09536f2da?raw)