/invitationevents/queuedafter/{dateUtc} – Alida Help Center

Get a list of invitations for members that have been 'queued' for deployment.

Prerequisites

Create an external invitation
The activity must be open and visible to members
The communication must be set to open
Members must be queued to receive the invitation

Resource URL

/v1/applications/{communityApiKeyName}/invitationevents/queuedafter/{dateUtc}

Note:

Use the appropriate regional endpoint to ensure that you comply with your organization's privacy policy, and applicable laws and regulations. For details about the available regional endpoints, and how to identify your organization's region, see Shared responsibility.

Available methods

Method	Description
GET	Returns a list of invitations for members eligible to participate in an activity.

Parameters

Parameters can be appended to the request to further refine the results returned.

Operation	Description	Example
Refine the response by field	To reduce the number of fields in the response, specify the fields in a comma separated list.	`queuedafter/{dateUtc}?fields=communicationId`
Filter the response by value	By default, all the items are returned unless you specify your criteria using the variable name and value. You can filter the response on the values in all of the available fields except for: `href` `eventDate` `createDate` `lastUpdateDate` `links` `href`	`queuedafter/{dateUtc}?activityName=MySurvey`
Paging	The default is 20 items are returned at a time and the maximum is 1000.	Use the `limit` and `offset` query string parameters to effectively page through the results.
Sorting	You can sort the results on the following fields: `activityLink` `communicationId` `createdBy` `description` `eventDate` `lastUpdatedBy` `title` Default is `eventDate`.	`queuedafter/{dateUtc}?sort=title:d`

Available Items

Field	Description
`activityId`	The GUID for the activity.
`activityLink`	The URL of the member-facing activity link.
`activityName`	The string name of the activity as it appears in the application.
`communicationId`	The GUID for the communication.
`communicationName`	The string name of the communication as it appears in the application.
`createDate`	The date-time UTC the invitation was created.
`createdBy`	The GUID for the user who created the invitation.
`description`	The string text of the invitation.
`eventDate`	The date-time UTC the activity is open to members.
`eventType`	This value will always be `Queued`.
`href`	The URL of the current request.
`id`	The GUID for the invitation.
`lastUpdateDate`	The date-time UTC the activity was created.
`lastUpdatedBy`	The GUID of the user who updated the event last.
`links`	This field is always empty.
`memberDataSetType`	This is always `Live`.
`memberId`	The GUID for the member to which this event applies
`title`	The subject line of the invitation.

For more information, see Member Events endpoints.

Example Response


{
  "meta": {
    "offset": 0,
    "limit": 20,
    "count": 1
  },
  "items": [
    {
      "id": <GUID of invitation event>,
      "communicationId": <GUID of communication>,
      "memberId": <GUID of member>,
      "activityId": <GUID of activity>,
      "activityName": <string name of activity>,
      "communicationName": "External Invitation",
      "activityLink": <URL of activity>,
      "title": <title of invitation>,
      "description": <description of invitation>,
      "eventType": <Queued>,
      "eventDate": <date-time UTC>,
      "memberDataSetType": "Live",
      "createDate": <date-time UTC>,
      "lastUpdateDate": <date-time UTC>,
      "createdBy": <GUID of user>,
      "lastUpdatedBy": <GUID of user>,
      "links": [],
      "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/invitationevents/queuedafter/{dateUtc}"
    }
  ],
  "links": [
    {
      "rel": "first",
      "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/invitationevents/queuedafter/{dateUtc}?offset=0&limit=20"
    },
    {
      "rel": "prev"
    },
    {
      "rel": "last"
    },
    {
      "rel": "next"
    }
  ],
  "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/invitationevents/queuedafter/{dateUtc}"
}