API ReferenceExports

Create subscription export OAuth Scope: subscriptions:write

<Warning>This is a gated feature that requires enablement. Contact support to enable Subscription Export API access for your publication.</Warning> 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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

publicationIdstringRequiredformat: "^(pub_[0-9a-fA-F\-]+)$"
The prefixed ID of the publication object

Request

This endpoint expects an object.
variantenumRequired
Which column set the export uses
Allowed values:
segment_idstringOptionalformat: "^(seg_[0-9a-fA-F\-]+)$"
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

OK
dataobjectOptional
reusedbooleanOptional
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
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error