Sign in
Badges

Create a new Badge

OAuth Scope

This endpoint requires the following OAuth scope manage_badges.

Record UUID

UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the x-record-uuid response header.

post/badge.json

Request body

uuidstring uuid

Unique identifier for this record

active0 | 1

Record active/deleted flag. Valid values are [0,1]

edit_datestring

Timestamp at which record was last modified

namestring required

The display name of the badge. Used to identify the badge in the system. Examples include 'Warranty', 'VIP', 'Take Payment Facilities', etc.

automatically_allocatedstring
file_namestring
regarding_form_uuidstring uuid
regarding_asset_type_uuidstring uuid

UUID of the asset type that this badge is associated with. Only applicable for asset-based badges. When set, the badge represents a specific asset type in the system and will appear on assets of this type.

Example request

{
  "uuid": "123e4567-30cf-42e5-b535-231d2261f72b",
  "edit_date": "2025-08-01 12:00:00",
  "regarding_form_uuid": "123e4567-b2a3-48d2-b3dd-231d29a89a4b",
  "regarding_asset_type_uuid": "123e4567-bb34-4ce0-8fe7-231d2d46f0fb"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes