Invite Collections

Invite Collections

Important

All requests must be signed according to the Dynata signing algorithm.

Receive Invites

The receive-invites endpoint is a message queue. When calling receive-invites you will receive up to 50 of the oldest messages at the head of the queue.

Static Invite Collections

If only consuming static invite collections it’s not necessary to read from the invite queue via the receive-invites endpoint. Updates to static invite collections will result in an entirely new collection being generated and available through a new opportunity. The download-invite-collection will return the full list of invites.

[
  {
    "invite": {
      "id": 17,
      "collection_id": "618400",
      "respondent_id": "2792483699",
      "expiration": "2023-05-10T00:55:32.344Z",
      "modified": "2023-01-19T02:23:34.225618Z",
      "created": "2023-01-19T02:23:34.225618Z"
    },
    "created": "2023-01-19T02:23:34.225618Z"
  },
  {
    "invite": {
      "id": 12,
      "collection_id": "618400",
      "respondent_id": "2792483700",
      "expiration": "2023-05-10T00:55:32.344Z",
      "modified": "2023-01-19T13:12:50.939425Z",
      "created": "2023-01-19T13:12:50.939425Z"
    },
    "created": "2023-01-19T13:12:50.939425Z"
  },
  {
    "invite": {
      "id": 3,
      "collection_id": "618400",
      "respondent_id": "2792483701",
      "expiration": "2023-05-10T00:55:32.344Z",
      "modified": "2023-01-24T18:16:12.189727Z",
      "created": "2023-01-19T13:13:10.971150Z"
    },
    "created": "2023-01-19T13:13:10.971150Z"
  }
]

Acknowledge Invites

Calling ack-invites removes the given messages from the queue, allowing you to retrieve the next set of messages from the queue with receive-invites. When an update or create event occurs, new messages will be added to the queue for the associated invites.

Download Invites

Using the download-invite-collection endpoint you can download all invites for an invite collection id or static invite collection id.

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