| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requestsā¦ | |||
This API allows you to create a group for the badges.
NoteFor 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
WarningBadge group name should be unique and is case sensitive.
Example request
curl --location 'https://eu.api.capillarytech.com/api_gateway/v1/badges/group' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
--header 'Authorization: Basic bWFkaHVzI3MjU2YQ==' \
--header 'Cookie: _cfuvid=LbgLgMATQVG7rxgU6obNtuTjuntKzGkHg15XluHdUPI-1768984490920-0.0.1.1-604800000' \
--data '{
"name": "skjhfdjfhgiok",
"rank": 214748364
}'Prerequisites
- Authentication: Basic or OAuth authentication
- Access group resource: WRITE access to target loyalty access group resource
Resource information
| URI | api_gateway/v1/badges/group |
| HTTP method | POST |
| Rate limit | NA |
| Batch support | NA |
Request body parameters
| Parameters | Datatype | Description |
|---|---|---|
| Name* | String | Name of the badge group. Ex: GROUP_RANK_2 |
| Rank* | Integer | The 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": "skjhfdjfhgiok",
"rank": 214748364
}Example response
{
"data": {
"id": "69708faa0772ad476ecf8511",
"orgId": 100737,
"name": "skjhfdjfhgiok",
"rank": 214748364,
"createdBy": 75197372,
"createdOn": 1768984490.856013000,
"createdOnISO": "2026-01-21T08:34:50Z",
"lastUpdatedBy": 75197372,
"lastUpdatedOn": 1768984490.856013000,
"lastUpdatedOnISO": "2026-01-21T08:34:50Z",
"isActive": true
},
"errors": [],
"warnings": []
}Response parameters
| Parameter | Datatype | Description |
|---|---|---|
| id | String | Unique ID of the group. |
| orgId | Integer | Unique iD of the org. |
| name | String | Name of the group |
| rank | Integer | The rank of the group assigned by the user. |
| createdBy | Integer | User ID who created the group. |
| createdOn | Float | Timestamp indicating when the group was created |
| createdOnISO | String | Timestamp indicating when the group was created, in ISO 8601 format, returned in the server time zone. EU server example 2025-12-16T14:30:45Z ā 16 December 2025, 14:30:45 (UTC) India server example 2025-12-16T14:30:45+05:30 ā 16 December 2025, 14:30:45 (IST) Note: The response time zone always matches the server time zone, regardless of the time zone offset in the request. |
| lastUpdatedBy | Integer | User ID who last updated the group. |
| lastUpdatedOn | Float | Timestamp indicating when the group was last updated |
| lastUpdatedOnISO | Timestamp indicating when the group was last updated, in ISO 8601 format, returned in the server time zone. EU server example 2025-12-16T14:30:45Z ā 16 December 2025, 14:30:45 (UTC) India server example 2025-12-16T14:30:45+05:30 ā 16 December 2025, 14:30:45 (IST) Note: The response time zone always matches the server time zone, regardless of the time zone offset in the request. | |
| isActive | Boolean | Indicates whether the group is currently active or not. |
API-specific error codes
| Error code | Description |
|---|---|
| 733 | Group Name should be Unique. |
| 732 | Group Rank is Mandatory. |
| 735 | Group name is mandatory. |