Please see the full REST API documentation for API implementation details.
Resource: Deleted Invitees
A deleted invitee contains information about an invitee that has been deleted from
a meeting series. This resource is of use to consumers of the invitee_deleted
REST
hook, and is provided so that integrations that need to react
to the deletion of an invitee can do so. The resource itself
provides the invitee_id, meeting_series_id, member_id, date of deletion, and, if available,
member_name and meeting series name.
Note that a person who has been removed from the set of invitees can be added back, and that doing so creates a new "invitee" with a distinct invitee_id from the removed resource.
Access note: Deleted invitee information can be accessed by users who can access the meeting series, as long as the meeting series itself is not deleted.
Properties
#| Field | Type | Notes |
|---|---|---|
| event_id | integer | This is not the same as the invitee_id. |
| invitee_id | integer | ID of the invitee that was deleted |
| meeting_series_id | tuple | meeting series: {meeting_series_id, name} |
| member_id | integer | |
| member_name | member name | |
| member_email | string, null | member's email address, if available |
| deleted_ts | timestamp | Time of deletion of the invitee. Note that this resource does not supply create_ts and update_ts. |
Getting a Single Deleted Invitee
#GET /lucid/api/v1/deleted_invitees/:event_id
Note that the event_id is not the same as the ID of the invitee that was deleted. API
users are expected to obtain the resource URL for a deleted invitee from an invitee_deleted REST
hook event.
| Query parameter | Notes |
|---|---|
| embed | (none supported) |
| fields | See Field Filtering |
| envelope | See Enveloping |
Sample Request
GET /lucid/api/v1/deleted_invitees/137189
Content-Type: application/json; charset=utf-8 Content-Length: 602 X-Requestor: afarrell@lucidmeetings.com X-Rate-Limit-Limit: 100 X-Rate-Limit-Remaining: 99 X-Rate-Limit-Used: 1 X-Rate-Limit-Reset: 60
{
"id": 137189,
"resource_url": "https://site.lucidmeetings.com/lucid/api/v1/deleted_invitees/137189",
"event_id": 137189,
"invitee_id": 967,
"meeting_series_id": {
"value": 655,
"display": "Weekly Review"
},
"member_id": 31,
"member_name": "Amy Farrell",
"member_email": "afarrell@lucidmeetings.com",
"deleted_ts": {
"value": 1581446255,
"iso_8601": "2020-02-11T18:37:35Z",
"pretty": {
"time": "10:37 AM",
"date": "February 11, 2020",
"timezone": "Los Angeles"
}
}
}