/invitationevents

Update the status of members queued for external invitations so you can track their participation status.

Prerequisite

Resource URL

/v1/applications/{communityApiKeyName}/invitationevents

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 API Access.

Available methods

Method Description
POST Updates the invitation status for a member.
Note: You cannot post a closed invitation.

Required fields

You must provide a value when posting:

  • memberId
  • communicationId
  • eventType <SurveyInvited|Undeliverable>

If you want a response value back, you have to include a header ({x-webapi-return-resource: true}), otherwise the request will always return status code 201.

Example POST request

POST https://api.{region}.alida.com/v1/applications/{commnityApiKeyName}/invitationevents
Authorization: Basic b3GbcmSheIRxcGTxYZRBYIT3RniwX5KsOlBhc3N3b3JkMQ==

[{
  "memberId": <GUID of member>,
  "communicationId": <GUID of communication>,
  "eventType": "SurveyInvited"
}]
Note: Messaging platforms that auto preview links will trigger Community to set the activity status to Started. This is a known issue and we are investigating options to manage this behavior.

POST response

Example POST Response

If eligible members are queued to receive the invitation, the response format will look like this: 


​[{
  "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": <subject of invitation>,
  "description": <invitation body>,
  "eventType": <SurveyInvited|Undeliverable>,
  "eventDate": <date-time UTC>,
  "memberDataSetType": "Live",
  "panelId": <GUID of panel>,
  "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/"
}]
Example POST Response: Zero members queued

If zero eligible members are queued to receive the invitation, the response format will look like this: 


{
   "meta": {
      "offset": 0,
      "limit": 20,
      "count": 0
   },
   "items": [],
   "links": [
      {
         "rel": "first"
      },
      {
         "rel": "prev"
      },
      {
         "rel": "last"
      },
      {
         "rel": "next"
      }
   ],
   "href": "https://api.{region}.alida.com/v1/applications/{commnityApiKeyName}/invitationevents/queuedafter/2017-02-28"
}

Field definitions

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 SurveyInvited or Undeliverable.
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.