Skip to main content
POST
Queue a communication coverage CSV export

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Body

application/json

Validated request fields for this operation.

view_mode
enum<string>

View mode. Validation: sometimes, string; allowed values: targets, rollups.

Available options:
targets,
rollups
Example:

"targets"

target_type
enum<string>

Target type. Validation: sometimes, string; allowed values: sponsorship_pair, donor, donor_program, all.

Available options:
sponsorship_pair,
donor,
donor_program,
all
Example:

"sponsorship_pair"

rollup_type
enum<string>

Rollup type. Validation: sometimes, string; allowed values: recipient, program.

Available options:
recipient,
program
Example:

"recipient"

column_order
string[]

Column order. Validation: sometimes, array, max:40.

Maximum array length: 40

Column order item. Validation: string, max:120.

Maximum string length: 120
sort
object

Sort. Validation: sometimes, array.

filters
object

Filters. Validation: sometimes, array.

Response

Operation result.

message
string
Example:

"Coverage export queued."

status
enum<string>
Available options:
queued
Example:

"queued"

export_id
integer

Organization-owned record identifier.

Example:

42