Request an async participant PII export

POST

/v1/campaign/export

curl --request POST \
  --url https://aggregator.example.com/v1/campaign/export \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "item_ids": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "metadata": [], "content": {} }'

• Your deployment's public host (set per instance)
• Local development

Creates a durable campaign job that exports the participant contact fields (name/email/phone, each with profile/user provenance) for the given owned items to a private CSV, and emails a short-lived pre-signed download link to the requesting user. Body is the shared campaign envelope { item_ids, metadata[], content{} }. Send an Idempotency-Key header to make retries safe. Returns 202 { job_id }; poll GET /v1/campaign/export/{job_id} for status.

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

item_ids

required

Array<string>

>= 1 items

metadata

Array<object>

default: <= 50 items

object

key

required

string

>= 1 characters <= 200 characters

value

required

string

<= 2000 characters

content

object

key

additional properties

Responses

202

Default Response

Media typeapplication/json

object

status

required

string

Allowed values: queued

requested

required

integer

job_id

required

string format: uuid

message

required

string

Example

{
  "status": "queued"
}

400

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

title

required

string

detail

required

string

docs

string

fields

object

key

additional properties

requestId

required

string

timestamp

required

string

key

additional properties

any

key

additional properties

any

Example^generated

{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

401

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

title

required

string

detail

required

string

docs

string

fields

object

key

additional properties

requestId

required

string

timestamp

required

string

key

additional properties

any

key

additional properties

any

Example^generated

{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

403

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

title

required

string

detail

required

string

docs

string

fields

object

key

additional properties

requestId

required

string

timestamp

required

string

key

additional properties

any

key

additional properties

any

Example^generated

{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

429

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

title

required

string

detail

required

string

docs

string

fields

object

key

additional properties

requestId

required

string

timestamp

required

string

key

additional properties

any

key

additional properties

any

Example^generated

{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

503

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

title

required

string

detail

required

string

docs

string

fields

object

key

additional properties

requestId

required

string

timestamp

required

string

key

additional properties

any

key

additional properties

any

Example^generated

{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}