/reminderevents – Alida Help Center

Update the status of members queued for external invitation reminders.

Prerequisite

Get a queued reminders

Resource URL

/v1/applications/{communityApiKeyName}/reminderevents

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
POST	Update the reminder status for a member. Note: You cannot POST to remind a member about an invitation if the invitation is closed or they are already being reminded about the invitation.

Required fields

You must provide a value when posting:

memberId
communicationId
eventType <Reminded|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}/reminderevents
Authorization: Basic b3GbcmSheIRxcGTxYZRBYIT3RniwX5KsOlBhc3N3b3JkMQ==

[{
  "memberId": <GUID of member>,
  "communicationId": <GUID of communication>,
  "eventType": "Reminded"
}]

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 reminder, the response format will look like this:


[{
  "id": <GUID of the reminder event>,
  "communicationId": <GUID of communication>,
  "memberId": <GUID of member>,
  "activityId": <GUID of activity>,
  "activityName": <string name of activity>,
  "communicationName": "External Invitation Reminder",
  "activityLink": <URL of activity>,
  "title": <title of the reminder>,
  "description": <description of the reminder>,
  "eventType": <Reminded|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}/reminderevents/"
}]

Example POST Response: Zero members queued

If zero eligible members are queued to receive the reminder, 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}/reminderevents/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 reminder was created.
`createdBy`	The GUID for the user who created the reminder.
`description`	The string text of the reminder.
`eventDate`	The date-time UTC the activity is open to members.
`eventType`	This value will always be `Reminded` or `Undeliverable`.
`href`	The URL of the current request.
`id`	The GUID for the reminder.
`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 reminder.