Sign in

v1

latestOpenAPI 3.1.02026-08-0653126213.6 KB
Badge

Create Badge Criteria

Add a new string to the badge's criteria. The input data could be anything typed by the user.

post/v1/badge/{badge_id}/criteria

Path parameters

badge_idinteger required

Headers

X-Access-Tokenstring nullable

Request body

external_idstring nullable
descriptionstring required
type'Application' | 'Assessment' | 'Award' | 'Badge' | 'Course' | 'Credential' | 'Education_Experience' | 'Leadership' | 'Member' | 'Participant' | 'Pathway' | 'Payment' | 'Portfolio' | 'Presenter' | 'Project' | 'Professional_Experience' | 'Schedule_Registration' | 'Volunteer' | 'Other' required
external_urlstring nullable
badge_idinteger nullable

Example request

{
  "external_id": "ABCD-EFG-HIJK-LMNOPQRS",
  "external_url": "https://apply.org"
}

Response

Successful Response

external_idstring nullable
descriptionstring nullable
type'Application' | 'Assessment' | 'Award' | 'Badge' | 'Course' | 'Credential' | 'Education_Experience' | 'Leadership' | 'Member' | 'Participant' | 'Pathway' | 'Payment' | 'Portfolio' | 'Presenter' | 'Project' | 'Professional_Experience' | 'Schedule_Registration' | 'Volunteer' | 'Other'
external_urlstring nullable
badge_idinteger nullable
idinteger nullable

Example response

{
  "external_id": "ABCD-EFG-HIJK-LMNOPQRS",
  "description": "Earners must have completed a three stage interview process before they can earn this badge.",
  "external_url": "https://apply.org"
}