Loading ...

REST API: Create Reminder | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Events » REST API: Event Reminders » REST API: Create Reminder
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 27

REST API: Create Reminder

0 
 /5
0 (0votes)
Open API Guide
PUT/api/events/reminder

Facilitates the addition of a reminder for a particular event.

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
EntityTypeIntegerYESBodyEntity type of event is 5. Not validated by the endpoint: a request without it answers 200 and stores the item with EntityType 0, which no list or page shows, so send it.
EntityIDIntegerYESBodyUnique ID of the event. Not validated by the endpoint: a request without it answers 200, so a missing value is not reported as an error.
ReminderTypeIntegerNOBodyThe time unit of the reminder. Refer to REST API: Event Reminder Types. Not enforced: the endpoint answers 200 without it.
ReminderTimeIntegerNOBodyNumber of minutes before the event to trigger the reminder (e.g., 15, 30, 60). Not enforced: the endpoint answers 200 without it.
UserIDIntegerYESBodyThe user to add a reminder for. Note: Only a site administrator can add a reminder for other users. Not validated by the endpoint: a request without it answers 200, so a missing value is not reported as an error.

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

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

Request Body

{
  "EntityType": 5,
  "EntityID": 153,
  "ReminderType": 1,
  "ReminderTime": 55,
  "UserID": 1017
}

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": {
    "ReminderID": 352,
    "EntityType": 5,
    "EntityID": 11359,
    "ReminderType": 1,
    "ReminderTime": 55,
    "UserID": 804,
    "ReminderSent": false,
    "TenantID": 1
  }
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required parameter is missing or invalid.",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestThe body is not valid JSON.Send a JSON reminder object.
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 IsErrorUserID is another user and the caller is not a site administrator (No permission).Send your own UserID, or call as a site administrator.

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