Badge assignments API

Give a badge to a piece of content or a user, and take it away again. To get a badge’s ID, list badges. Before you start, read the API overview for how authentication, headers, pagination and errors work.

Assign a badge

Assign a badge to a piece of content or a user.

string

required

The ID of the badge to assign.

string

required

The ID of the record you’re assigning the badge to.

string

required

The type of record you’re assigning the badge to. Accepts Content or User.

string

The URL of a certificate or other third-party verification.

Assign a badge

curl -X POST "https://your-community.zapnito.com/api/v1/badges/1/assign" \
  -H "Authorization: Token token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{"id": "2", "type": "Content", "verification_url": "https://example.com/certificate"}'

POST https://your-community.zapnito.com/api/v1/badges/:badge_id/assign

{
  "message": "Badge #1 assigned to Content #2"
}

Remove a badge assignment

Remove a badge from a piece of content or a user.

string

required

The ID of the badge to remove.

string

required

The ID of the record you’re removing the badge from.

string

required

The type of record you’re removing the badge from. Accepts Content or User.

Remove a badge assignment

curl -X DELETE "https://your-community.zapnito.com/api/v1/badges/1/unassign" \
  -H "Authorization: Token token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{"id": "2", "type": "Content"}'

DELETE https://your-community.zapnito.com/api/v1/badges/:badge_id/unassign

{
  "message": "Badge #1 unassigned from Content #2"
}

Getting started

Users

Groups and organisations

Content

Channels and rooms

Badges

Assign a badge

Remove a badge assignment

​Assign a badge

​Remove a badge assignment

Assign a badge

Remove a badge assignment