Skip to content

Download invites

POST
/download-invite-collection

Download all invites for invite collections or static invite collections.

dynata-expiration
required
string format: date-time

RFC3339 timestamp indicating request expiration

dynata-access-key
required
string

Dynata provided access key

Example
ADSF23ADF354GFDDS23
dynata-signature
required
string

Signature created using the Dynata methodology

Example
dsklj435kljhfdSAFdsalk34
object
id

The invite collection identifier

string

List of all invite notifications for account in csv format

id,collection_id,respondent_id,expiration,created,modified
4,618400,2792483702,2023-05-10T00:55:32.344Z,2023-01-24T18:14:45.694610Z,2023-01-19T13:13:31.167732Z
3,618400,2792483701,2023-05-10T00:55:32.344Z,2023-01-24T18:16:12.189727Z,2023-01-19T13:13:10.971150Z
5,618400,2792483703,2023-05-10T00:55:32.344Z,2023-01-19T13:13:51.891820Z,2023-01-19T13:13:51.891820Z
status
string
Allowed values: AVAILABLE EMPTY_PAYLOAD
Transfer-Encoding
string

Chunked

Processing time will vary by invite collection

The fetched invite collection is being processed. Try again in 5 to 10 seconds.

status
string
Allowed values: PROCESSING

Bad request

object
message
required

A human readable description of the error

string

Invalid credentials

object
message
required

A human readable description of the error

string

Unauthorized

object
message
required

A human readable description of the error

string

Invite collection not found

object
error
required
string
Allowed values: invite collection with id {invite_collection_id} was not found

Internal server error

object
message
required

A human readable description of the error

string
status
string
Allowed values: NOT_AVAILABLE