Badges

Create badge

POST

https://discourse.example.com/admin/badges.json

Create badge

curl -X POST 'https://discourse.example.com/admin/badges.json' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "name": "string",
  "badge_type_id": 0
}'

const body = `{
  "name": "string",
  "badge_type_id": 0
}`;

const response = await fetch('https://discourse.example.com/admin/badges.json', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "name": "string",
  "badge_type_id": 0
}'''

response = requests.post(
    'https://discourse.example.com/admin/badges.json',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "name": "string",
  "badge_type_id": 0
}

200

{
  "badge_types": [
    {
      "id": 0,
      "name": "string",
      "sort_order": 0
    }
  ],
  "badge": {
    "id": 0,
    "name": "string",
    "description": "string",
    "grant_count": 0,
    "allow_title": true,
    "multiple_grant": true,
    "icon": "string",
    "image_url": "string",
    "image_upload_id": 0,
    "listable": true,
    "enabled": true,
    "badge_grouping_id": 0,
    "system": true,
    "long_description": "string",
    "slug": "string",
    "manually_grantable": true,
    "query": "string",
    "trigger": "string",
    "target_posts": true,
    "auto_revoke": true,
    "show_posts": true,
    "badge_type_id": 0,
    "show_in_post_header": true
  }
}

Body

application/json

namestringrequired

The name for the new badge.

badge_type_idintegerrequired

The ID for the badge type. 1 for Gold, 2 for Silver, 3 for Bronze.

Response

200OKany

success response

Response fields application/json

badge_typesArray<object>required

Show child attributes

idintegerrequired

namestringrequired

sort_orderintegerrequired

badgeobjectrequired

Show child attributes

idintegerrequired

namestringrequired

descriptionstringrequired

grant_countintegerrequired

allow_titlebooleanrequired

multiple_grantbooleanrequired

iconstringrequired

image_urlstring | nullrequired

image_upload_idinteger | nullrequired

listablebooleanrequired

enabledbooleanrequired

badge_grouping_idintegerrequired

systembooleanrequired

long_descriptionstringrequired

slugstringrequired

manually_grantablebooleanrequired

querystring | nullrequired

triggerstring | nullrequired

target_postsbooleanrequired

auto_revokebooleanrequired

show_postsbooleanrequired

badge_type_idintegerrequired

show_in_post_headerbooleanrequired

Docs by Sourcey