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 29

REST API: Create Reminder

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

Adds or updates a user's reminder for an 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
EntityIDIntegerYESBodyUnique ID of the event. The endpoint does not check it. Without it, or with a value that is not a number, the request answers 200 and the reminder is saved against event 0.
UserIDIntegerYESBodyThe user to add a reminder for. Only a site administrator can add a reminder for other users. Left out, it is 0, which counts as another user. A caller who is not a site administrator is then refused with No permission. A value that is not a number is read as 0 and refused the same way.
EntityTypeIntegerYESBodySend 5, the entity type for an event. The endpoint does not check it: a request without it answers 200 and stores the item with EntityType 0. A value that is not a number is also stored as 0. A reminder saved with EntityType 0 is not listed by Get Reminders and cannot be removed with Delete Reminder.

Optional Parameters

ParameterTypeRequiredLocationDescription
ReminderTypeIntegerNOBodyThe time unit of the reminder. Refer to REST API: Event Reminder Types. Not enforced: the endpoint answers 200 without it. Left out, or a value that is not a number, it is saved as 0; a number outside the list is saved as sent.
ReminderTimeIntegerNOBodyNumber of ReminderType units before the event to trigger the reminder (for example, 15 with ReminderType 1 is 15 minutes). Not enforced: the endpoint answers 200 without it. Left out, or a value that is not a number, it is saved as 0.

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": 366,
    "EntityType": 5,
    "EntityID": 11545,
    "ReminderType": 1,
    "ReminderTime": 55,
    "UserID": 804,
    "ReminderSent": false,
    "TenantID": 1
  }
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "No Permission"
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestNot returned: a body that is not valid JSON is read as no reminder, and the call fails with 500 instead.Send a JSON reminder object.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenThe endpoint does not return this status. A caller who may not add the reminder gets 200 with IsError true; see the No permission row.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