Claim badge

This API allows you to claim the badge using badge ID.

๐Ÿ‘

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}/claim
HTTP methodPOST
PaginationNA
Rate limitNA
Batch supportNA

API endpoint example

https://eucrm.cc.capillarytech.com/api_gateway/v1/badges/badgeMeta/653df084b3cda7078c7c68f1/claim

Request path parameters

Parameter NameData TypeDescription
badgeID*StringUnique identifier ("id") generated during the creation of the badge. Ex: 653df084b3cda7078c7c68f1

Request body parameters

ParameterData TypeDescription
ownerType*EnumThe module for which the badge is being claimed.
Supported values: Loyalty, Loyalty_Promotion, Referral_Campaigns, Journeys, Audience_Campaigns, Rewards_Catalog, Goodwill_Module, Milestones, Historical_Import
referenceId*StringEnter a unique identifier to identify the badge owner (ownerType).
https://eucrm.cc.capillarytech.com/api_gateway/v1/badges/badgeMeta/653df084b3cda7078c7c68f1/claim
{
    "ownerType": "Loyalty",
    "referenceId": "123"
}

Response parameters

ParameterData TypeDescription
badgeMetaIdStringUnique identifier for the badge metadata.
ownerTypeStringThe module for which the badge is being claimed.
referenceIdStringAn identifier associated with the owner.
errorsStringContains details of any errors.
warningsArrayContains details of any warnings.
{
    "data": {
        "badgeMetaId": "653df084b3cda7078c7c68f1",
        "ownerType": "Loyalty",
        "referenceId": "123"
    },
    "errors": null,
    "warnings": []
}

API-specific error codes

Error codeDescription
717OwnerId is mandatory.
400Invalid enum value.
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!