Revoke enrolled badges

This API allows you to revoke the enrolment of a badge for the customer.

๐Ÿ‘

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/customer/revokeIssue
HTTP methodPOST
Rate limitNA
Batch supportNA

API endpoint example

https://eucrm.cc.capillarytech.com/api_gateway/v1/badges/badgeMeta/customer/revokeIssue

Request body parameters

ParameterData TypeDescription
badgeMetaId*StringUnique identifier ("id") generated during the creation of the badge
customerId*StringUnique identifier for the customer related to the revoked badge.
{
  "badgeMetaId": "653de84db3cda7078c7c68ed",
  "customers": [
    62090013
  ]
}
{
  "badgeMetaId": "654bb48766a87827bb61e631",
  "customers": [
    123,62090013
  ]
}

Response parameters

ParameterData TypeDescription
badgeMetaIdStringUnique identifier for the badge metadata.
revokedIssuedBadgesArrayObject representing a revoked issued badge.
customerIdStringUnique identifier for the customer related to the revoked badge.
issuedIdStringUnique identifier for the issued badge that was revoked.
errorObjectObject to indicate any errors.
requestIdStringA unique identifier for the request.
errorsArrayArray to list any errors.
warningsArrayArray to list any warnings.
{
    "data": {
        "badgeMetaId": "653de84db3cda7078c7c68ed",
        "revokedIssuedBadges": [
            {
                "customerId": 62090013,
                "issuedId": "653e024bb3cda7078c7c6903",
                "error": null
            }
        ],
        "requestId": null
    },
    "errors": [],
    "warnings": []
}
{
    "data": {
        "badgeMetaId": "654bb48766a87827bb61e631",
        "revokedIssuedBadges": [
            {
                "customerId": 123,
                "issuedId": "654cc02b6bccde1274b6d3a7",
                "error": null
            },
            {
                "customerId": 62090013,
                "issuedId": "654cc03e6bccde1274b6d3a9",
                "error": null
            }
        ],
        "requestId": null
    },
    "errors": [],
    "warnings": []
}

API-specific error codes

Error codeDescription
404Passed badge is not found
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!