Create badges group

This API allows you to create a group for the badges.

πŸ‘

Note

For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call

🚧

Warning

Badge group name should be unique and is case sensitive.

Prerequisites

  • Authentication: Basic or OAuth authentication
  • Access group resource: WRITE access to target loyalty access group resource

Resource information

URIapi_gateway/v1/badges/group
HTTP methodPOST
Rate limitNA
Batch supportNA

API endpoint example

https://eu.api.capillarytech.com/api_gateway/v1/badges/group

Request body parameters

ParametersDatatypeDescription
Name*StringName of the badge group. Ex: GROUP_RANK_2
Rank*IntegerThe rank of the group is used to create an order among different groups. The brand assigns the rank, and groups with higher rank are prioritized over other groups.

Ex: To encourage customers as they progress through course modules, you can organize badges into three groups corresponding to three-course modules. After completing each module, customers earn a badge. Upon achieving a set of badges, they are associated with a group such as Expert, Intermediate, or Beginner.
{
       "name": "GROUP_RANK_2",
       "rank": 2
}

Response parameters

ParameterDatatypeDescription
idStringUnique ID of the group.
orgIdIntegerUnique iD of the org.
nameStringName of the group
rankIntegerThe rank of the group assigned by the user.
createdByIntegerUser ID who created the group.
createdOnFloatTimestamp indicating when the group was created
lastUpdatedByIntegerUser ID who last updated the group.
lastUpdatedOnFloatTimestamp indicating when the group was last updated
isActiveBooleanIndicates whether the group is currently active or not.
{
    "data": {
        "id": "6581281e8f68666070de15c5",
        "orgId": 50156,
        "name": "GROUP_RANK_4",
        "rank": 2,
        "createdBy": 123,
        "createdOn": 1702963230.966423000,
        "lastUpdatedBy": 123,
        "lastUpdatedOn": 1702963230.966423000,
        "isActive": true
    },
    "errors": [],
    "warnings": []
}

API-specific error codes

Error codeDescription
733Group Name should be Unique.
732Group Rank is Mandatory.
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!