Loading ...

REST API: Update RSVP | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Events » REST API: Update RSVP
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 24

REST API: Update RSVP

0 
 /5
0 (0votes)
Open API Guide
PUT/api/events/{EventID}/rsvp/me/status

Set the calling user's RSVP for an event, or for one instance of a recurring event. ResponseData is the attendance value that was set.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.
Content-TypeYESapplication/jsonMust be set to application/json

Required Parameters

ParameterTypeRequiredLocationDescription
EventIDIntegerYESPathUnique ID of the event
RSVPStatusIntegerYESBodyAttendance status to set, sent as the bare JSON body: 1 Attending, 2 Maybe attending, 3 Not attending. Refer to REST API: Event Attendance Types.

Optional Parameters

ParameterTypeRequiredLocationDescription
InstanceOptionIntegerNOQueryFor a recurring event, which instances the RSVP applies to: 1 All (default), 2 this and future instances, 3 a single instance.
InstanceStringNOQueryThe instance date the RSVP applies to when InstanceOption is 2 or 3.
DeleteAttendUserBooleanNOQuerytrue also removes the caller from the event's attendee list when InstanceOption is 1. Default: false.

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

https://your-site.com/api/events/185/rsvp/me/status

Request Body

2

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": 2
}

Error Response

{
  "Message": "The request is invalid."
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestEventID in the path is not an integer, or the body is missing or not an attendance value.Send a numeric EventID and a bare attendance value as the body.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
500 Server ErrorInternal failure.Retry later.
200 with IsErrorThe event has reached its maximum number of attendees (EventMaxAttendeesReached).Send 3 (Not attending), which is always accepted, or wait for a place.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages