This API allows you to unclaim a badge. Using an unclaim API you can soft delete the active claim from the claims list.

For example:

A badge named Furry Friend Badge is owned by Loyalty and Milestones. Loyalty has successfully claimed the badge under program ID: 123, associating the badge claim with Loyalty as owner and reference ID: ABC. Using the unclaim badge API, you can remove Loyalty’s claim over 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}`/unclaim
HTTP Method	POST
Pagination	No
Batch support	No

Example request

curl --location 'https://eu.api.capillarytech.com/api_gateway/v1/badges/badgeMeta/69381220cebb9648d8974518/unclaim' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
--header 'Authorization: Basic bWFkaHjU2YQ==' \
--header 'Cookie: _cfuvid=h41NNNJlaGGCp71UuFTcMjP3q.OYkoR9IigSN5f_pGY-1768819014360-0.0.1.1-604800000' \
--data '
{
  "ownerType": "Loyalty",
  "referenceId": "123"
}'

Request path parameters

Parameter Name	Data Type	Description
badgeId*	String	Unique ID of the badge.

Request body parameters

Parameter Name	Data Type	Description
ownerType*	Enum	Module where the badge was claimed. Supported values: Loyalty, Loyalty_Promotion, Referral_Campaigns, Journeys, Audience_Campaigns, Rewards_Catalog, Goodwill_Module, Milestones, Historical_Import
referenceId*	String	Unique reference ID of the owner type.

{
"ownerType":"Loyalty",
"referenceId":"string"
}

Example response

{
    "data": {
        "ownerType": "Loyalty",
        "referenceId": "123",
        "isActive": false
    },
    "errors": null,
    "warnings": []
}

Response parameters

Parameter Name	Data Type	Description
ownerType	Enum	Module wheere the badge was claimed. Supported values: Loyalty program, Milestones, Campaigns, Journeys, Goodwill.
referenceId	String	Unique reference ID of the owner type.
isActive	Boolean	Indicates whether the badge is active.

API-specific error codes

Error code	Description
737	Claim not found in existing claims