FOforem
badges

Create a badge

Changed on

Create a new badge. Requires administrator privileges. Successful writes log api_badge_create with the actor and target ids in the admin API audit log.

Body Parameter Guidelines:

  • title: Unique name for the badge.
  • description: Text explanation of the achievement.
  • remote_badge_image_url: Public URL to an image asset (PNG, GIF, or SVG) representing the badge icon.
  • allow_multiple_awards: Set to true if a user can earn the same badge multiple times (e.g. weekly challenges).
post/api/badges

Request

  • Base URL
    https://dev.to
  • Auth
    • API key in header api-key
    • or HTTP bearer

Request body

Response

created

idinteger required
titlestring required
slugstring required
descriptionstring required
credits_awardedinteger
allow_multiple_awardsboolean
created_atstring date-time required
updated_atstring date-time required

Changes