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.

Example request

curl --location --request PUT 'https://eu.api.capillarytech.com/api_gateway/v1/badges/group/69708faa0772ad476ecf8511' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
--header 'Authorization: Basic bWFkaHVfcmltYTowZjAwNmZlNGM4ZjFhNmRjMmI2ZDI1N2NkNzI3MjU2YQ==' \
--header 'Cookie: _cfuvid=Wkaspor1BmNbRX4j31OHCHRfrJcYmaBKaFE_pmj9vaU-1771232084786-0.0.1.1-604800000' \
--data '
{
  "name": "GROUP_RANK_59",
  "rank": 1
}
'

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/`group_id`
HTTP method	POST
Rate limit	NA
Batch support	NA

API endpoint example

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

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": "GROUP_RANK_59",
    "rank": 1
}

Example response

{
    "data": {
        "id": "69708faa0772ad476ecf8511",
        "orgId": 100737,
        "name": "GROUP_RANK_59",
        "rank": 1,
        "createdBy": 75197372,
        "createdOn": 1768984490.856000000,
        "createdOnISO": "2026-01-21T08:34:50Z",
        "lastUpdatedBy": 75197372,
        "lastUpdatedOn": 1771247122.421232000,
        "lastUpdatedOnISO": "2026-02-16T13:05:22Z",
        "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
lastUpdatedOn		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.

{
    "data": {
        "id": "6968c1330772ad476ecf33b0",
        "orgId": 100737,
        "name": "GROUP_RANK_58",
        "rank": 1,
        "createdBy": 75197941,
        "createdOn": 1768472883.053000000,
        "createdOnISO": "2026-01-15T10:28:03Z",
        "lastUpdatedBy": 75197941,
        "lastUpdatedOn": 1768473600.277013000,
        "lastUpdatedOnISO": "2026-01-15T10:40:00Z",
        "isActive": true
    },
    "errors": [],
    "warnings": []
}

API-specific error codes

Error code	Description
733	Group Name should be Unique.
732	Group Rank is Mandatory.

200200

400400