Loading ...

REST API: Create Event Resource | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Events » REST API: Event Resources » REST API: Create Event Resource
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 30

REST API: Create Event Resource

0 
 /5
0 (0votes)
Open API Guide
POST/api/events/resources

Create an event resource (a room or item that events in the listed spaces can reserve). On success, ResponseData holds the new resource, with its ResourceID. ResponseMessage holds the name of the returned object's type rather than a message.

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
ResourceNameStringYESBodyName of the event resource
LocationStringYESBodyLocation of the event resource. A JSON list instead of text fails the call (200 with IsError true).
DescriptionStringYESBodyDescription of the event resource. A JSON list instead of text fails the call (200 with IsError true).

Optional Parameters

ParameterTypeRequiredLocationDescription
EventResourceTypeIDIntegerNOBodyUnique ID of the event resource type for the event resource
SpaceIDCSVStringNOBodyComma-separated list of spaces that can use the event resource

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

https://your-site.com/api/events/resources

Request Body

{
  "ResourceName": "Conference Room A",
  "Location": "Office Building A",
  "Description": "Place for large meetings",
  "EventResourceTypeID": 1,
  "SpaceIDCSV": "205,206,207"
}

Success Response

{
  "IsError": false,
  "ResponseMessage": "Communifire.Common.BusinessEntities.Events.EventResource",
  "ResponseData": {
    "ResourceID": 43,
    "ResourceName": "Conference Room A 0880",
    "Location": "Office Building A",
    "Description": "Place for large meetings",
    "EventResourceTypeID": 1,
    "CalendarURL": "/events/resources/43/calendar",
    "SpaceIDCSV": "205,206,207",
    "DateCreated": "2026-09-13T01:56:47.3281869Z",
    "TenantID": 1
  }
}

Error Response

{"IsError": true, "ResponseMessage": "System.Data.SqlClient.SqlException (0x80131904): Procedure or function 'Dyve_Event_Resource_Save' expects parameter '@ResourceName', which was not supplied. ..."}

Error Handling

Status CodeLikely CauseNext Action
200 with IsErrorA required parameter is missing or invalid. The endpoint answers 200 and reports the problem in ResponseMessage, with IsError true.Read IsError on every response, not the status code; verify the request against the required parameters.
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