Create badge

POST 
/admin/badges.json

Create badge

Request

application/json

Body

name stringrequired

The name for the new badge.

badge_type_id integerrequired

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

Responses

200

success response

application/json

Schema

Schema

badge_types object[]required
Array [
id integerrequired
name stringrequired
sort_order integerrequired
]
badge objectrequired
id integerrequired
name stringrequired
description stringrequired
grant_count integerrequired
allow_title booleanrequired
multiple_grant booleanrequired
icon stringrequired
image_url stringnullrequired
listable booleanrequired
enabled booleanrequired
badge_grouping_id integerrequired
system booleanrequired
long_description stringrequired
slug stringrequired
manually_grantable booleanrequired
query stringnullrequired
trigger stringnullrequired
target_posts booleanrequired
auto_revoke booleanrequired
show_posts booleanrequired
badge_type_id integerrequired

Example (from schema)

{
  "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",
    "listable": true,
    "enabled": true,
    "badge_grouping_id": 0,
    "system": true,
    "long_description": "string",
    "slug": "string",
    "manually_grantable": true,
    "target_posts": true,
    "auto_revoke": true,
    "show_posts": true,
    "badge_type_id": 0
  }
}

Loading...