Create reward group

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

๐Ÿ‘

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 .

Prerequisites

  • Authentication: Basic or OAuth authentication
  • Default access group

Resource information

URI/api_gateway/core/v1/group/create
HTTP methodPOST
PaginationNA
Rate limitNA
Batch supportNA

API endpoint example

https://eucrm.cc.capillarytech.com/api_gateway/core/v1/group/create

Request body parameters

Parameter NameData TypeDescription
name*StringThe name of the group. The name of the group must be unique.
rankIntegerThe rank associated with the group. Group rank can be null.
{
    "name":"GROUP_withRANK123",
    "rank":99
}

Response parameters

Parameter NameData TypeDescription
idIntegerThe unique identifier of the group.
orgIdIntegerThe organization identifier the group belongs to.
nameStringThe name of the group.
rankIntegerThe numerical rank associated with the group.
isActiveBooleanIndicates if the group is active.
createdByIntegerThe identifier of the user who created the group.
createdOnLongThe timestamp when the group was created.
lastUpdatedByIntegerThe identifier of the user who last updated the group.
lastUpdatedOnLongThe timestamp when the group was last updated.
{
    "id": 42,
    "orgId": 51544,
    "name": "Group Ranking",
    "rank": 1,
    "isActive": true,
    "createdBy": 50684454,
    "createdOn": 1708500949361,
    "lastUpdatedBy": 50684454,
    "lastUpdatedOn": 1708500949361
}

API-specific error

Error codeDescription
400Group name must not be null
12012Group name must be unique
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!