Update badges group

πŸ‘

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 details
  • Access group resource: WRITE access to target loyalty access group resource

Resource information

URIapi_gateway/v1/badges/group/{groupid}
HTTP methodPOST
Rate limitNA
Batch supportNA

API endpoint example

https://eu.api.capillarytech.com/api_gateway/v1/badges/{groupid}

Request query parameters

ParametersDatatypeDescription
groupId*StringUnique ID of the group.

Request body parameters

ParametersDatatypeDescription
Name*StringName of the group.
Rank*IntegerThe brand assigns the rank of the group. The rank is used to create an order among different groups. The group with the higher rank is prioritized over the other groups.
{
       "name": "GROUP_RANK_58",
       "rank": 1
}

Response parameters

ParameterDatatypeDescription
idStringUnique ID of the group.
orgIdIntegerUnique ID of the org.
nameStringName of the group
rankIntegerRank of the group.
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
{
        "id": "6581281e8f68666070de15c5",
        "orgId": 50156,
        "name": "GROUP_RANK_58",
        "rank": 1,
        "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!