> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.beehiiv.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.beehiiv.com/_mcp/server.

# Create subscription export <Badge intent="info" minimal outlined>OAuth Scope: subscriptions:write</Badge>

POST https://api.beehiiv.com/v2/publications/{publicationId}/exports/subscriptions
Content-Type: application/json

This is a gated feature that requires enablement. Contact support to enable Subscription Export API access for your publication.Starts a subscriber-list export and returns the export object to poll. When an export of the same variant and scope is already running, that in-flight export is returned unchanged with `reused` set to true rather than a second one being started, so this endpoint is safe to call on a schedule.

Reference: https://developers.beehiiv.com/api-reference/exports/create

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `publicationId` (string, required) — The prefixed ID of the publication object

### Body (application/json)

This endpoint expects an object.

- `variant` (enum, required) — Which column set the export uses
  - Allowed values: `full`, `basic`
- `segment_id` (string, optional) — Optional prefixed ID of a segment to scope the export to. When omitted the export covers the whole publication. A segment that does not exist, or belongs to another publication, answers 404.

## Response

### 200

OK

- `data` (SubscriptionExport, optional)
- `reused` (boolean, optional) — True when an export of this variant and scope was already running and has been returned unchanged instead of a new one being started. This is what makes the endpoint safe to call on a schedule.

## Errors

### 400 Bad Request Error

Bad Request

- `status` (integer, required)
- `statusText` (string, required)
- `errors` (list of ErrorDetail, required)

### 401 Unauthorized Error

Unauthorized. The API key or OAuth access token is missing, invalid, or expired.

- `status` (integer, required)
- `statusText` (string, required)
- `errors` (list of ErrorDetail, required)

### 403 Forbidden Error

Forbidden

- `status` (integer, required)
- `statusText` (string, required)
- `errors` (list of ErrorDetail, required)

### 404 Not Found Error

Resource Not Found

- `status` (integer, required)
- `statusText` (string, required)
- `errors` (list of ErrorDetail, required)

### 429 Too Many Requests Error

Rate Limit Exceeded

- `status` (integer, required)
- `statusText` (string, required)
- `errors` (list of ErrorDetail, required)

### 500 Internal Server Error

Internal Server Error

- `status` (integer, required)
- `statusText` (string, required)
- `errors` (list of ErrorDetail, required)

## Types

### SubscriptionExport

- `id` (string, optional) — The ID of the export object
- `variant` (enum, optional) — Which column set the export uses
  - Allowed values: `full`, `basic`
- `status` (enum, optional) — The status of the export
  - Allowed values: `pending`, `preparing`, `processing`, `completed`, `failed`
- `publication_id` (string, optional) — The publication ID associated with this export
- `segment_id` (string, optional) — The segment the export is scoped to. Absent when the export covers the whole publication.
- `failure_reason` (string, optional) — Set when the export status is `failed`. A fixed message, the underlying error is not exposed. Empty string otherwise.
- `download_url` (string, optional) — A signed, time-limited link to the CSV. Null until the export status is `completed`. Minted fresh on each read, so a client polling later still receives a working link.
- `completed` (integer, optional) — The timestamp of the export's completion. Null until the export status is `completed`.
- `created` (integer, optional) — The timestamp of the export's creation
- `updated` (integer, optional) — The timestamp of the export's update

### ErrorDetail

- `message` (string, required)
- `code` (string, required)

## Examples

**Request**

```json
{
  "variant": "full"
}
```

**Response**

```json
{
  "data": {
    "id": "export_a3f1c2d4-e5b6-7890-abcd-ef1234567890",
    "variant": "full",
    "status": "pending",
    "publication_id": "pub_7b2e9f1a-3c4d-5e6f-8a9b-0c1d2e3f4a5b",
    "failure_reason": "",
    "download_url": null,
    "completed": null,
    "created": 1716825600,
    "updated": 1716825600
  },
  "reused": false
}
```

**SDK Code**

```python
import requests

url = "https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/exports/subscriptions"

payload = { "variant": "full" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/exports/subscriptions';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"variant":"full"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/exports/subscriptions"

	payload := strings.NewReader("{\n  \"variant\": \"full\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/exports/subscriptions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"variant\": \"full\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/exports/subscriptions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"variant\": \"full\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/exports/subscriptions', [
  'body' => '{
  "variant": "full"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/exports/subscriptions");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"variant\": \"full\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["variant": "full"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/exports/subscriptions")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```