Loading ...

REST API: Invite Users to Event | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Events » REST API: Invite Users to Event
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 23

REST API: Invite Users to Event

0 
 /5
0 (0votes)
Open API Guide
PUT/api/events/{EventID}/invitees/members

Invite site members to an event by their user IDs. ResponseData is the string True when the invitations were added, otherwise False.

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
UserIDCSVStringYESBodyComma-separated user IDs of the members to invite, sent as a JSON string (for example "12,34").

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

https://your-site.com/api/events/130/invitees/members

Request Body

"1018,1030"

Success Response

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

Error Response

HTTP 400 with an empty body

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestEventID is 0 or less or not an integer, or the body is missing (no user list to split); the response has no body.Send a positive EventID and a JSON string 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.

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