Skip to content
Arsen API Documentation

Export campaign

GET
/v1/campaigns/{id}/export

Export a file of details from a campaign that has previously been created.

Parameters

Path Parameters

id
required
string

Query Parameters

format
required
string
Allowed values: csv pdf
locale
required
string
default: en
Allowed values: en fr

Only required when format is pdf

Responses

200

object
status
required
string
Allowed values: success
data
required
object
fileUrl
required

The URL to download the exported file

string format: uri

400

Bad request

object
error
string
statusCode
required
number

401

Unauthorized

object
message
required
string
statusCode
required
number

404

Not found

object
message
required
string
statusCode
required
number

408

Request timeout

object
message
required
string
statusCode
required
number

429

Too many requests

object
message
required
string
statusCode
required
number

500

Internal server error

object
message
required
string
statusCode
required
number