Update activation status of badge

This API allows you to update the activation status of the badge.

๐Ÿ‘

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/v1/badges/badgeMeta/{badgeId}/{activationStatus}
HTTP methodPUT
PaginationNA
Rate limitNA
Batch supportNA

API endpoint example

https://eucrm.cc.capillarytech.com/api_gateway/v1/badges/badgeMeta/6543688e66a87827bb61e62a/activate

Request path parameter

ParameterData TypeDescription
activationStatus*EnumActivation status of the badge.
Supported values: Activate, Deactivate
badgeId*StringUnique identifier ("id") generated during the creation of the badge
https://eucrm.cc.capillarytech.com/api_gateway/v1/badges/badgeMeta/6543688e66a87827bb61e62a/activate
https://eucrm.cc.capillarytech.com/api_gateway/v1/badges/badgeMeta/6543688e66a87827bb61e62a/deactivate

Response parameter

ParameterData TypeDescription
idStringUnique identifier for the badge.
isActiveBooleanIndicates whether the badge is active.
errorsArrayContains details of any errors.
warningsArrayContains details of any warnings.
{
    "data": {
        "id": "6543688e66a87827bb61e62a",
        "isActive": true
    },
    "errors": [],
    "warnings": []
}
{
    "data": {
        "id": "6543688e66a87827bb61e62a",
        "isActive": false
    },
    "errors": [],
    "warnings": []
}
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!