latestOpenAPI 3.0.12026-08-1091181421.2 KB

44eb39b4bd65

BadgeClasses

Update an existing ClaimCode for a BadgeClass

put/v2/badgeclasses/{idOrEntityId}/claim-codes/{claimCode}

Path parameters

idOrEntityIdstring required

claimCodestring required

Request body

expirationDatestring date-time nullable

labelstring nullable

The label of the claim code

limitinteger nullable

The number of times the claim code can be used

Example request

{
  "label": "Conference Event",
  "limit": 10
}

Response

errorCodestring nullable

fieldErrorsobject required

latestTermsVersioninteger nullable

nonFieldErrorsstring[] required

timestampstring date-time nullable

validationErrorsstring[] required

warningsobject required

Example response

{
  "result": [
    {
      "code": "5678945",
      "label": "Conference Event",
      "limit": 10
    }
  ],
  "status": {
    "description": "ok"
  }
}