Sign in

v1

latestOpenAPI 3.1.02026-08-0653126213.6 KB
Badge

Update Badge Endorsement

Update a specific badge endorsement

put/v1/badge/endorsement/{endorsement_id}

Path parameters

endorsement_idinteger required

Headers

X-Access-Tokenstring nullable

Request body

external_idstring nullable
namestring nullable
descriptionstring nullable
urlstring nullable
image_urlstring nullable
image_url_2xstring nullable
image_url_originalstring nullable

Example request

{
  "external_id": "zyxw-vut-srq-ponmlkjih",
  "url": "https://Endorsement/Example.org",
  "image_url": "https://media.navigatr.app/endorsement.webp",
  "image_url_2x": "https://media.navigatr.app/endorsement_2x.webp",
  "image_url_original": "https://media.navigatr.app/endorsement_original.webp"
}

Response

Successful Response

external_idstring nullable
namestring nullable
descriptionstring nullable
urlstring nullable
image_urlstring nullable
image_url_2xstring nullable
image_url_originalstring nullable
idinteger nullable
badge_idinteger nullable

Example response

{
  "external_id": "zyxw-vut-srq-ponmlkjih",
  "name": "Endorsement Example",
  "description": "This is an example of a badge endorsement",
  "url": "https://Endorsement/Example.org",
  "image_url": "https://media.navigatr.app/endorsement.webp",
  "image_url_2x": "https://media.navigatr.app/endorsement_2x.webp",
  "image_url_original": "https://media.navigatr.app/endorsement_original.webp"
}