Download invites

POST

/download-invite-collection

curl --request POST \
  --url https://registry.rex.dynata.com/download-invite-collection \
  --header 'Content-Type: application/json' \
  --header 'dynata-access-key: ADSF23ADF354GFDDS23' \
  --header 'dynata-expiration: 2026-04-15T12:00:00Z' \
  --header 'dynata-signature: dsklj435kljhfdSAFdsalk34' \
  --data '{ "id": "example" }'

• Production
• Sandbox

Download all invites for invite collections or static invite collections.

Parameters

Header Parameters

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

Request Body

Media typeapplication/json

object

id

The invite collection identifier

string

Example^generated

{
  "id": "example"
}

Responses

200

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

Headers

status

string

Allowed values: AVAILABLE EMPTY_PAYLOAD

Transfer-Encoding

string

Chunked

204

Processing time will vary by invite collection. 

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

Headers

status

string

Allowed values: PROCESSING

400

Bad request

Media typeapplication/json

object

message

required

A human readable description of the error

string

Example^generated

{
  "message": "example"
}

401

Invalid credentials

Media typeapplication/json

object

message

required

A human readable description of the error

string

Example^generated

{
  "message": "example"
}

403

Unauthorized

Media typeapplication/json

object

message

required

A human readable description of the error

string

Example^generated

{
  "message": "example"
}

404

Invite collection not found

Media typeapplication/json

object

error

required

string

Allowed values: invite collection with id {invite_collection_id} was not found

Example

{
  "error": "invite collection with id {invite_collection_id} was not found"
}

500

Internal server error

Media typeapplication/json

object

message

required

A human readable description of the error

string

Example^generated

{
  "message": "example"
}

Headers

status

string

Allowed values: NOT_AVAILABLE