REST: Events

Generated from mnema-talk v3.3.13 (cca4f0fdb723).

List role templates

GET /api/event-role-templates

Sets of roles to start an event's role list from. Members see the templates an administrator enabled; administrators see all, including the disabled presets that ship with the server.

Authentication: Session cookie

Responses

StatusMeaningBody
200OKRoleTemplate[]

Create a role template

POST /api/event-role-templates

Adds a template (enabled unless enabled is false). Administrators only.

Authentication: Session cookie

Request body (application/json, required): RoleTemplateRequest

FieldTypeDescription
enabledboolean
namestring
rolesRoleInput[]

Responses

StatusMeaningBody
201CreatedRoleTemplate
400INVALID_INPUTErrorResponse
403FORBIDDENErrorResponse
409CONFLICT: the name is taken or there are 50 templates.ErrorResponse
RoleTemplate
FieldTypeDescription
enabled (required)boolean
id (required)string (uuid)
name (required)string
preset (required)booleanPreset marks a template that ships with the server; it can be enabled and disabled, not deleted.
roles (required)RoleInput[]

Delete a role template

DELETE /api/event-role-templates/{templateID}

Removes a template. A preset that ships with the server cannot be deleted, only disabled. Administrators only.

Authentication: Session cookie

Parameters

NameInTypeRequiredDescription
templateIDpathstring (uuid)yesTemplate ID

Responses

StatusMeaningBody
204Deleted.
403FORBIDDENErrorResponse
404NOT_FOUNDErrorResponse
409CONFLICT: the template is a preset.ErrorResponse

Update a role template

PATCH /api/event-role-templates/{templateID}

Changes the fields sent: enabled, name or roles. A preset can only be enabled or disabled. Administrators only.

Authentication: Session cookie

Parameters

NameInTypeRequiredDescription
templateIDpathstring (uuid)yesTemplate ID

Request body (application/json, required): RoleTemplateRequest

FieldTypeDescription
enabledboolean
namestring
rolesRoleInput[]

Responses

StatusMeaningBody
200OKRoleTemplate
400INVALID_INPUTErrorResponse
403FORBIDDENErrorResponse
404NOT_FOUNDErrorResponse
409CONFLICT: the name is taken, or the change is to a preset's content.ErrorResponse
RoleTemplate
FieldTypeDescription
enabled (required)boolean
id (required)string (uuid)
name (required)string
preset (required)booleanPreset marks a template that ships with the server; it can be enabled and disabled, not deleted.
roles (required)RoleInput[]

List community events

GET /api/events

Returns community events visible to the caller, ordered by start time. Events located in a Talk channel require ViewChannel on that channel. By default the window runs from 1 day ago to 90 days ahead; an event is in the window while it has not ended before after and starts before before.

Authentication: Session cookie

Parameters

NameInTypeRequiredDescription
afterquerystring (date-time)noEarliest end (or start, for events without an end) to include, RFC 3339. Default: now minus 1 day.
beforequerystring (date-time)noEvents must start before this time, RFC 3339. Default: now plus 90 days.
whenquerystringnoupcoming (default) or past. past lists events that are over (completed, cancelled or ended), newest first, and ignores after; page it with before and before_id.
before_idquerystring (uuid)noWith when=past: id of the last event of the previous page; together with before (its start time) it continues the list.
limitqueryintegernoPage size, 1 to 200.

Responses

StatusMeaningBody
200OKCommunityEvent[]
400INVALID_INPUTErrorResponse

Create a community event

POST /api/events

Creates an event. With recurrence the event is the first occurrence of a series that repeats weekly, every two weeks or monthly (at the same wall-clock time in the given time zone; the later occurrences are created up to 60 days ahead and then by the server as time passes, at most 200 and not past until). Requires ManageEvents permission. Location must be either a Talk voice channel or free text. Automod screens the title, description and location like a message in the event's Talk (a blocking rule answers 400).

Authentication: Session cookie

Request body (application/json, required): CreateEventRequest

FieldTypeDescription
channel_idstring | null
description (required)string
end_timestring | null
locationstring | null
recurrenceRecurrenceRequestRecurrence makes this event the first of a series that repeats weekly, every two weeks or monthly.
start_time (required)string (date-time)
title (required)string

Responses

StatusMeaningBody
201CreatedCommunityEvent
400INVALID_INPUTErrorResponse
403FORBIDDENErrorResponse
CommunityEvent
FieldTypeDescription
channel_idstring | null
cover_urlstring | null
created_at (required)string (date-time)
created_bystring | null
description (required)string
end_timestring | null
going_membersUserRef[]
id (required)string (uuid)
locationstring | null
my_rsvpstring | null
my_signupSignupMySignup is the caller's own sign-up for a role; the answer to a request, never broadcast.
rolesEventRole[]Roles are the event's roles with their sign-up counts (in position order).
rsvp_counts (required)RSVPCounts
seriesSeriesInfoSeries is set when the event is an occurrence of a recurring event.
signupsSignupItem[]Signups lists who is signed up for which role (event details only).
start_time (required)string (date-time)
status (required)string
title (required)string
updated_at (required)string (date-time)

Get a community event

GET /api/events/{id}

Returns event details with RSVPs. If in a Talk channel, requires ViewChannel.

Authentication: Session cookie

Parameters

NameInTypeRequiredDescription
idpathstring (uuid)yesEvent ID

Responses

StatusMeaningBody
200OKCommunityEvent
404NOT_FOUNDErrorResponse
CommunityEvent
FieldTypeDescription
channel_idstring | null
cover_urlstring | null
created_at (required)string (date-time)
created_bystring | null
description (required)string
end_timestring | null
going_membersUserRef[]
id (required)string (uuid)
locationstring | null
my_rsvpstring | null
my_signupSignupMySignup is the caller's own sign-up for a role; the answer to a request, never broadcast.
rolesEventRole[]Roles are the event's roles with their sign-up counts (in position order).
rsvp_counts (required)RSVPCounts
seriesSeriesInfoSeries is set when the event is an occurrence of a recurring event.
signupsSignupItem[]Signups lists who is signed up for which role (event details only).
start_time (required)string (date-time)
status (required)string
title (required)string
updated_at (required)string (date-time)

Update a community event

PATCH /api/events/{id}

Updates an event. Requires ManageEvents permission. "end_time": null removes the end time; an event without an end counts as over two hours after it starts. Moving the start or end re-derives the status of an event that is not cancelled. The status follows the event's times: PATCH accepts status "cancelled" (same as POST cancel) or the current status, and any other change is refused with 409. Automod screens the title, description and location the edit sets like a message (a blocking rule answers 400).

Authentication: Session cookie

Parameters

NameInTypeRequiredDescription
idpathstring (uuid)yesEvent ID
scopequerystringnothis (default) or following: with following, an occurrence of a series and every later open occurrence take the edit and the series' template changes with it (a new start_time becomes the series' new anchor; occurrences before it stay).

Request body (application/json, required): UpdateEventRequest

FieldTypeDescription
channel_idstring | null
descriptionstring
end_timestring | null
locationstring | null
start_timestring (date-time)
statusstring
titlestring

Responses

StatusMeaningBody
200OKCommunityEvent
400INVALID_INPUTErrorResponse
403FORBIDDENErrorResponse
404NOT_FOUNDErrorResponse
409CONFLICT: the status change is not allowed.ErrorResponse
CommunityEvent
FieldTypeDescription
channel_idstring | null
cover_urlstring | null
created_at (required)string (date-time)
created_bystring | null
description (required)string
end_timestring | null
going_membersUserRef[]
id (required)string (uuid)
locationstring | null
my_rsvpstring | null
my_signupSignupMySignup is the caller's own sign-up for a role; the answer to a request, never broadcast.
rolesEventRole[]Roles are the event's roles with their sign-up counts (in position order).
rsvp_counts (required)RSVPCounts
seriesSeriesInfoSeries is set when the event is an occurrence of a recurring event.
signupsSignupItem[]Signups lists who is signed up for which role (event details only).
start_time (required)string (date-time)
status (required)string
title (required)string
updated_at (required)string (date-time)

Cancel a community event

POST /api/events/{id}/cancel

Marks an event as cancelled. Requires ManageEvents permission. An event that is already cancelled or completed is refused with 409.

Authentication: Session cookie

Parameters

NameInTypeRequiredDescription
idpathstring (uuid)yesEvent ID
scopequerystringnothis (default) or following: cancel an occurrence of a series and every later open occurrence and end the series there.

Responses

StatusMeaningBody
200OKCommunityEvent
403FORBIDDENErrorResponse
404NOT_FOUNDErrorResponse
409CONFLICT: the event is already cancelled or completed.ErrorResponse
CommunityEvent
FieldTypeDescription
channel_idstring | null
cover_urlstring | null
created_at (required)string (date-time)
created_bystring | null
description (required)string
end_timestring | null
going_membersUserRef[]
id (required)string (uuid)
locationstring | null
my_rsvpstring | null
my_signupSignupMySignup is the caller's own sign-up for a role; the answer to a request, never broadcast.
rolesEventRole[]Roles are the event's roles with their sign-up counts (in position order).
rsvp_counts (required)RSVPCounts
seriesSeriesInfoSeries is set when the event is an occurrence of a recurring event.
signupsSignupItem[]Signups lists who is signed up for which role (event details only).
start_time (required)string (date-time)
status (required)string
title (required)string
updated_at (required)string (date-time)

List the comments of an event

GET /api/events/{id}/comments

A page of the event's comments, oldest first. Without before it is the newest page; before names the oldest comment already loaded and returns the page ahead of it. has_more says older comments exist; muted says the caller switched the notices of this event's comments off. If the event is in a Talk, requires ViewChannel.

Authentication: Session cookie

Parameters

NameInTypeRequiredDescription
idpathstring (uuid)yesEvent ID
beforequerystring (uuid)noComment ID: return the comments before it.
limitqueryintegernoPage size, 1 to 100.

Responses

StatusMeaningBody
200OKCommentList
400INVALID_INPUTErrorResponse
404NOT_FOUNDErrorResponse
CommentList
FieldTypeDescription
comments (required)EventComment[]
has_more (required)boolean
muted (required)booleanMuted says the caller switched the notices of this event's comments off.

Comment on an event

POST /api/events/{id}/comments

Adds a comment of 1 to 2000 characters (no replies; an event keeps at most 500, one member at most 50 of them). Needs Send messages (in the event's Talk when it has one: a timeout, unaccepted rules and a new member's hold refuse it). Comments stay open on a completed event and close on a cancelled one (409). Announces the comment to everyone who may see the event (event_comment) and tells the event's creator and attendees, who did not mute it, by event_comment_notice and Web Push. Automod screens the text like a message in the event's Talk (a blocking rule answers 400). Rate limited per member.

Authentication: Session cookie

Parameters

NameInTypeRequiredDescription
idpathstring (uuid)yesEvent ID

Request body (application/json, required): CommentRequest

FieldTypeDescription
content (required)string

Responses

StatusMeaningBody
201CreatedEventComment
400INVALID_INPUTErrorResponse
403FORBIDDEN or RULES_NOT_ACCEPTEDErrorResponse
404NOT_FOUNDErrorResponse
409CONFLICT: the event is cancelled, holds 500 comments already, or the member left 50.ErrorResponse
429RATE_LIMITEDErrorResponse
EventComment
FieldTypeDescription
content (required)string
created_at (required)string (date-time)
edited_atstring | null
event_id (required)string (uuid)
id (required)string (uuid)
user (required)UserRef

Mute or unmute the notices of an event's comments

PUT /api/events/{id}/comments/mute

Sets whether the caller is told about new comments of this event (the creator and attendees are by default).

Authentication: Session cookie

Parameters

NameInTypeRequiredDescription
idpathstring (uuid)yesEvent ID

Request body (application/json, required): CommentMute

FieldTypeDescription
muted (required)boolean

Responses

StatusMeaningBody
200OKCommentMute
404NOT_FOUNDErrorResponse
CommentMute
FieldTypeDescription
muted (required)boolean

Delete a comment

DELETE /api/events/{id}/comments/{commentID}

Removes a comment. The author may delete their own; the event's creator and members with Manage events or Manage messages (server-wide) may delete any (audited).

Authentication: Session cookie

Parameters

NameInTypeRequiredDescription
idpathstring (uuid)yesEvent ID
commentIDpathstring (uuid)yesComment ID

Responses

StatusMeaningBody
204Deleted.
403FORBIDDENErrorResponse
404NOT_FOUNDErrorResponse

Edit a comment

PATCH /api/events/{id}/comments/{commentID}

Changes the text of the caller's own comment (shown as edited). Needs Send messages like a new comment. Automod screens the new text like an edited message (400). Rate limited per member.

Authentication: Session cookie

Parameters

NameInTypeRequiredDescription
idpathstring (uuid)yesEvent ID
commentIDpathstring (uuid)yesComment ID

Request body (application/json, required): CommentRequest

FieldTypeDescription
content (required)string

Responses

StatusMeaningBody
200OKEventComment
400INVALID_INPUTErrorResponse
403FORBIDDEN: not the author.ErrorResponse
404NOT_FOUNDErrorResponse
429RATE_LIMITEDErrorResponse
EventComment
FieldTypeDescription
content (required)string
created_at (required)string (date-time)
edited_atstring | null
event_id (required)string (uuid)
id (required)string (uuid)
user (required)UserRef

Remove event cover image

DELETE /api/events/{id}/cover

Deletes the event cover image. Requires ManageEvents.

Authentication: Session cookie

Parameters

NameInTypeRequiredDescription
idpathstring (uuid)yesEvent ID

Responses

StatusMeaningBody
200OKCommunityEvent
403FORBIDDENErrorResponse
404NOT_FOUNDErrorResponse
CommunityEvent
FieldTypeDescription
channel_idstring | null
cover_urlstring | null
created_at (required)string (date-time)
created_bystring | null
description (required)string
end_timestring | null
going_membersUserRef[]
id (required)string (uuid)
locationstring | null
my_rsvpstring | null
my_signupSignupMySignup is the caller's own sign-up for a role; the answer to a request, never broadcast.
rolesEventRole[]Roles are the event's roles with their sign-up counts (in position order).
rsvp_counts (required)RSVPCounts
seriesSeriesInfoSeries is set when the event is an occurrence of a recurring event.
signupsSignupItem[]Signups lists who is signed up for which role (event details only).
start_time (required)string (date-time)
status (required)string
title (required)string
updated_at (required)string (date-time)

Upload event cover image

POST /api/events/{id}/cover

Sets the event cover image (PNG, JPEG, GIF or WebP, up to 5 MB). Crops to 3:1 ratio and strips metadata. Requires ManageEvents.

Authentication: Session cookie

Parameters

NameInTypeRequiredDescription
idpathstring (uuid)yesEvent ID

Request body (multipart/form-data, required): object

FieldTypeDescription
cover (required)string (binary)Cover image file (at most 5 MB)

Responses

StatusMeaningBody
200OKCommunityEvent
400INVALID_INPUTErrorResponse
403FORBIDDENErrorResponse
404NOT_FOUNDErrorResponse
413PAYLOAD_TOO_LARGEErrorResponse
415UNSUPPORTED_MEDIA_TYPEErrorResponse
503UNAVAILABLE: file storage is not available, or image processing is busy.ErrorResponse
CommunityEvent
FieldTypeDescription
channel_idstring | null
cover_urlstring | null
created_at (required)string (date-time)
created_bystring | null
description (required)string
end_timestring | null
going_membersUserRef[]
id (required)string (uuid)
locationstring | null
my_rsvpstring | null
my_signupSignupMySignup is the caller's own sign-up for a role; the answer to a request, never broadcast.
rolesEventRole[]Roles are the event's roles with their sign-up counts (in position order).
rsvp_counts (required)RSVPCounts
seriesSeriesInfoSeries is set when the event is an occurrence of a recurring event.
signupsSignupItem[]Signups lists who is signed up for which role (event details only).
start_time (required)string (date-time)
status (required)string
title (required)string
updated_at (required)string (date-time)

Set the roles of an event

PUT /api/events/{id}/roles

Replaces the event's role list (at most 12; each with a name of up to 40 characters, an optional emoji and a capacity of 1 to 1000, or none for unlimited). A role sent with its id keeps its sign-ups; one that is left out is removed, which is refused with 409 while it has sign-ups (hand them over with DELETE .../roles/{roleID}?move_to=). A capacity below the number of confirmed members is refused with 409 naming how many to remove; a larger capacity moves the waitlist up. Allowed for the event's creator and for members with Manage events; not on a completed or cancelled event. The two steps of scope=following (this occurrence, then the series) are separate transactions: when the second fails the first stays. The event's creator, who needs no Manage events for this, can thereby change the roles of the whole future series.

Authentication: Session cookie

Parameters

NameInTypeRequiredDescription
idpathstring (uuid)yesEvent ID
scopequerystringnothis (default) or following: also the later occurrences of a series.

Request body (application/json, required): SetRolesRequest

FieldTypeDescription
roles (required)RoleInput[]

Responses

StatusMeaningBody
200OKCommunityEvent
400INVALID_INPUTErrorResponse
403FORBIDDENErrorResponse
404NOT_FOUNDErrorResponse
409CONFLICT: the event is over, a role to remove has sign-ups, a capacity is below the confirmed members, or two roles share a name.ErrorResponse
CommunityEvent
FieldTypeDescription
channel_idstring | null
cover_urlstring | null
created_at (required)string (date-time)
created_bystring | null
description (required)string
end_timestring | null
going_membersUserRef[]
id (required)string (uuid)
locationstring | null
my_rsvpstring | null
my_signupSignupMySignup is the caller's own sign-up for a role; the answer to a request, never broadcast.
rolesEventRole[]Roles are the event's roles with their sign-up counts (in position order).
rsvp_counts (required)RSVPCounts
seriesSeriesInfoSeries is set when the event is an occurrence of a recurring event.
signupsSignupItem[]Signups lists who is signed up for which role (event details only).
start_time (required)string (date-time)
status (required)string
title (required)string
updated_at (required)string (date-time)

Delete a role of an event

DELETE /api/events/{id}/roles/{roleID}

Removes a role. A role with sign-ups is refused with 409 unless move_to names another role of the event, which takes the sign-ups over (members who held a slot keep their place in line). Allowed for the event's creator and for members with Manage events; not on a completed or cancelled event.

Authentication: Session cookie

Parameters

NameInTypeRequiredDescription
idpathstring (uuid)yesEvent ID
roleIDpathstring (uuid)yesRole ID
move_toquerystring (uuid)noAnother role of the event that takes the sign-ups over.

Responses

StatusMeaningBody
200OKCommunityEvent
400INVALID_INPUTErrorResponse
403FORBIDDENErrorResponse
404NOT_FOUNDErrorResponse
409CONFLICT: the event is over or the role has sign-ups and no move_to.ErrorResponse
CommunityEvent
FieldTypeDescription
channel_idstring | null
cover_urlstring | null
created_at (required)string (date-time)
created_bystring | null
description (required)string
end_timestring | null
going_membersUserRef[]
id (required)string (uuid)
locationstring | null
my_rsvpstring | null
my_signupSignupMySignup is the caller's own sign-up for a role; the answer to a request, never broadcast.
rolesEventRole[]Roles are the event's roles with their sign-up counts (in position order).
rsvp_counts (required)RSVPCounts
seriesSeriesInfoSeries is set when the event is an occurrence of a recurring event.
signupsSignupItem[]Signups lists who is signed up for which role (event details only).
start_time (required)string (date-time)
status (required)string
title (required)string
updated_at (required)string (date-time)

Delete RSVP response for an event

DELETE /api/events/{id}/rsvp

Removes caller's RSVP from the event. A role slot the caller held is given up too, and its waitlist moves up.

Authentication: Session cookie

Parameters

NameInTypeRequiredDescription
idpathstring (uuid)yesEvent ID

Responses

StatusMeaningBody
200OKCommunityEvent
404NOT_FOUNDErrorResponse
CommunityEvent
FieldTypeDescription
channel_idstring | null
cover_urlstring | null
created_at (required)string (date-time)
created_bystring | null
description (required)string
end_timestring | null
going_membersUserRef[]
id (required)string (uuid)
locationstring | null
my_rsvpstring | null
my_signupSignupMySignup is the caller's own sign-up for a role; the answer to a request, never broadcast.
rolesEventRole[]Roles are the event's roles with their sign-up counts (in position order).
rsvp_counts (required)RSVPCounts
seriesSeriesInfoSeries is set when the event is an occurrence of a recurring event.
signupsSignupItem[]Signups lists who is signed up for which role (event details only).
start_time (required)string (date-time)
status (required)string
title (required)string
updated_at (required)string (date-time)

Set RSVP response for an event

PUT /api/events/{id}/rsvp

Sets caller's response to going, interested, or not_going. Case, surrounding spaces and a space or hyphen instead of the underscore are tolerated ("Not Going"). A sign-up for a role counts as going, so any other answer also gives up the caller's role slot and moves its waitlist up.

Authentication: Session cookie

Parameters

NameInTypeRequiredDescription
idpathstring (uuid)yesEvent ID

Request body (application/json, required): RSVPRequest

FieldTypeDescription
response (required)string

Responses

StatusMeaningBody
200OKCommunityEvent
400INVALID_INPUTErrorResponse
404NOT_FOUNDErrorResponse
409CONFLICT: the event is cancelled or completed.ErrorResponse
CommunityEvent
FieldTypeDescription
channel_idstring | null
cover_urlstring | null
created_at (required)string (date-time)
created_bystring | null
description (required)string
end_timestring | null
going_membersUserRef[]
id (required)string (uuid)
locationstring | null
my_rsvpstring | null
my_signupSignupMySignup is the caller's own sign-up for a role; the answer to a request, never broadcast.
rolesEventRole[]Roles are the event's roles with their sign-up counts (in position order).
rsvp_counts (required)RSVPCounts
seriesSeriesInfoSeries is set when the event is an occurrence of a recurring event.
signupsSignupItem[]Signups lists who is signed up for which role (event details only).
start_time (required)string (date-time)
status (required)string
title (required)string
updated_at (required)string (date-time)

List RSVPs for an event

GET /api/events/{id}/rsvps

Lists members who responded to the event.

Authentication: Session cookie

Parameters

NameInTypeRequiredDescription
idpathstring (uuid)yesEvent ID

Responses

StatusMeaningBody
200OKRSVPItem[]
404NOT_FOUNDErrorResponse

Leave the role of an event

DELETE /api/events/{id}/signup

Removes the caller's sign-up and moves the role's waitlist up. Always allowed, also on a finished event and for a member who can no longer view the event (a Talk they lost access to) but had a sign-up: such a member gets 204 instead of the event. Without a sign-up an event the caller cannot view is 404, as everywhere. The RSVP stays as it is.

Authentication: Session cookie

Parameters

NameInTypeRequiredDescription
idpathstring (uuid)yesEvent ID

Responses

StatusMeaningBody
200OKCommunityEvent
204Left; the caller can no longer view the event.
404NOT_FOUNDErrorResponse
CommunityEvent
FieldTypeDescription
channel_idstring | null
cover_urlstring | null
created_at (required)string (date-time)
created_bystring | null
description (required)string
end_timestring | null
going_membersUserRef[]
id (required)string (uuid)
locationstring | null
my_rsvpstring | null
my_signupSignupMySignup is the caller's own sign-up for a role; the answer to a request, never broadcast.
rolesEventRole[]Roles are the event's roles with their sign-up counts (in position order).
rsvp_counts (required)RSVPCounts
seriesSeriesInfoSeries is set when the event is an occurrence of a recurring event.
signupsSignupItem[]Signups lists who is signed up for which role (event details only).
start_time (required)string (date-time)
status (required)string
title (required)string
updated_at (required)string (date-time)

Sign up for a role of an event

PUT /api/events/{id}/signup

Puts the caller on a role: confirmed while the role has room, otherwise on its waitlist (the answer's my_signup says which, and the place in line). A member who holds another role of the event moves over and the old role's waitlist moves up. The capacity check runs under a lock, so the last slot is never given twice. A sign-up counts as RSVP going. Everyone who can view the event may sign up while it is scheduled or active.

Authentication: Session cookie

Parameters

NameInTypeRequiredDescription
idpathstring (uuid)yesEvent ID

Request body (application/json, required): SignupRequest

FieldTypeDescription
role_id (required)string (uuid)

Responses

StatusMeaningBody
200OKCommunityEvent
400INVALID_INPUTErrorResponse
404NOT_FOUNDErrorResponse
409CONFLICT: the event is completed or cancelled.ErrorResponse
CommunityEvent
FieldTypeDescription
channel_idstring | null
cover_urlstring | null
created_at (required)string (date-time)
created_bystring | null
description (required)string
end_timestring | null
going_membersUserRef[]
id (required)string (uuid)
locationstring | null
my_rsvpstring | null
my_signupSignupMySignup is the caller's own sign-up for a role; the answer to a request, never broadcast.
rolesEventRole[]Roles are the event's roles with their sign-up counts (in position order).
rsvp_counts (required)RSVPCounts
seriesSeriesInfoSeries is set when the event is an occurrence of a recurring event.
signupsSignupItem[]Signups lists who is signed up for which role (event details only).
start_time (required)string (date-time)
status (required)string
title (required)string
updated_at (required)string (date-time)

Remove a member from the roster of an event

DELETE /api/events/{id}/signup/{userID}

Removes another member's sign-up and moves the role's waitlist up; the member is told. Allowed for the event's creator and for members with Manage events; not on a completed or cancelled event.

Authentication: Session cookie

Parameters

NameInTypeRequiredDescription
idpathstring (uuid)yesEvent ID
userIDpathstring (uuid)yesMember ID

Responses

StatusMeaningBody
200OKCommunityEvent
403FORBIDDENErrorResponse
404NOT_FOUNDErrorResponse
409CONFLICT: the event is completed or cancelled.ErrorResponse
CommunityEvent
FieldTypeDescription
channel_idstring | null
cover_urlstring | null
created_at (required)string (date-time)
created_bystring | null
description (required)string
end_timestring | null
going_membersUserRef[]
id (required)string (uuid)
locationstring | null
my_rsvpstring | null
my_signupSignupMySignup is the caller's own sign-up for a role; the answer to a request, never broadcast.
rolesEventRole[]Roles are the event's roles with their sign-up counts (in position order).
rsvp_counts (required)RSVPCounts
seriesSeriesInfoSeries is set when the event is an occurrence of a recurring event.
signupsSignupItem[]Signups lists who is signed up for which role (event details only).
start_time (required)string (date-time)
status (required)string
title (required)string
updated_at (required)string (date-time)

Something wrong on this page? Tell us.