Loading ...

REST API: Recognize User | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Recognition » REST API: Recognize User
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 22

REST API: Recognize User

0 
 /5
0 (0votes)
Open API Guide
POST/api/recognition

Grant a recognition award badge to another user, with a message, from the calling user. ResponseData carries the new award's AwardID and the WallID of the wall post announcing it.

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
ToUserIDIntegerYESQueryThe user ID of the user to recognize
AwardContentIDIntegerYESQueryContent ID of the recognition award badge to grant to the user.
ReasonStringYESQueryA message to attach to the award

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

https://your-site.com/api/recognition?ToUserID=5&AwardContentID=6&Reason=Thanks%20for%20your%20quick%20response%20to%20tickets!

Success Response

{
  "IsError": false,
  "ResponseMessage": "Badge awarded successfully.",
  "ResponseData": {
    "WallID": 8,
    "AwardID": 4
  }
}

Error Response

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

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestToUserID or AwardContentID is missing or not an integer, or Reason is missing.Send all three values in the query string.
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 award was already granted (duplicate), no user has ToUserID, or no award has AwardContentID; ResponseMessage says which.Check the two IDs and whether the badge was already given.

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