Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Claim badge

post/api_gateway/v1/badges/badgeMeta/{badgeId}/claim

Path parameters

badgeIdstring required

Unique Identifier for the badge.Unique Identifier for the badge.

Request body

ownerType'LOYALTY/REFERRAL_CAMPAIGNS/JOURNEYS/AUDIENCE_CAMPAIGNS/ REWARDS_CATALOG/ GOODWILL_MODULE/ MILESTONES' required

The module for which the badge is being claimed.

referenceIdstring required

A unique identifier associated with the owner.

Response

200

OR

Example response

{
  "data": {
    "ownerType": "Loyalty",
    "referenceId": "626"
  },
  "warnings": [
    {
      "code": 900,
      "message": "Badge is already claimed by this owner"
    }
  ]
}