Add badge

POST {{baseUrl}}/api/v1/badges

This API adds a badge to your user community.

OAuth Scope

  • Desk.settings.CREATE

Attributes

Attribute NameData TypeDescription
name (required)<string>
max chars : 200
Name of the badge
description<string>
max chars : 200
Description of the badge
isCustom (required)<boolean>
Key that specifies if the badge is user-defined or not
customIconId<int>
ID of the file attachment that contains the badge icon
defaultIconId<int>
ID of the default icon

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{&quot;name&quot;:&quot;Badge 1&quot;,&quot;isCustom&quot;:&quot;true&quot;,&quot;description&quot;:&quot;Best Contributor&quot;,&quot;levelName&quot;:null,&quot;id&quot;:&quot;1&quot;,&quot;iconUrl&quot;:&quot;https://www.zylker.com/badge1.jpg&quot;}