Badges API

{
  "badges": [
    {
      "id": 1,
      "type": "Content",
      "text": "Audit ready",
      "color": "#88FED8",
      "text_color": "#18181B",
      "cta_label": "Read the audit checklist",
      "cta_url": "https://example.com/audit-checklist",
      "available_to_anyone": false,
      "position": 0,
      "brand_image_url": "https://example.com/audit-ready-image.png",
      "brand_logo_url": "https://example.com/audit-ready-logo.png"
    },
    {
      "id": 2,
      "type": "User",
      "text": "Compliance expert",
      "color": "#A28BFE",
      "text_color": "#18181B",
      "cta_label": "Meet our experts",
      "cta_url": "https://example.com/our-experts",
      "available_to_anyone": false,
      "position": 0,
      "brand_image_url": "https://example.com/compliance-expert-image.png",
      "brand_logo_url": "https://example.com/compliance-expert-logo.png"
    }
  ]
}

{
  "badges": [
    {
      "id": 1,
      "type": "Content",
      "text": "Audit ready",
      "color": "#88FED8",
      "text_color": "#18181B",
      "cta_label": "Read the audit checklist",
      "cta_url": "https://example.com/audit-checklist",
      "available_to_anyone": false,
      "position": 0,
      "brand_image_url": "https://example.com/audit-ready-image.png",
      "brand_logo_url": "https://example.com/audit-ready-logo.png"
    },
    {
      "id": 2,
      "type": "User",
      "text": "Compliance expert",
      "color": "#A28BFE",
      "text_color": "#18181B",
      "cta_label": "Meet our experts",
      "cta_url": "https://example.com/our-experts",
      "available_to_anyone": false,
      "position": 0,
      "brand_image_url": "https://example.com/compliance-expert-image.png",
      "brand_logo_url": "https://example.com/compliance-expert-logo.png"
    }
  ]
}

Manage the badges in your community. Each badge is for either content or users. To give a badge to a piece of content or a user, see Badge assignments. Before you start, read the API overview for how authentication, headers, pagination and errors work.

List badges

Return the badges in your community.

integer

The page of results to return.

integer

default:20

The number of results to return per page.

string

A search term to reduce the number of results. Matches the badge text.

string

Only return badges of this type. Accepts Content or User.

List badges

curl "https://your-community.zapnito.com/api/v1/badges?type=Content" \
  -H "Authorization: Token token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8"

GET https://your-community.zapnito.com/api/v1/badges

{
  "badges": [
    {
      "id": 1,
      "type": "Content",
      "text": "Audit ready",
      "color": "#88FED8",
      "text_color": "#18181B",
      "cta_label": "Read the audit checklist",
      "cta_url": "https://example.com/audit-checklist",
      "available_to_anyone": false,
      "position": 0,
      "brand_image_url": "https://example.com/audit-ready-image.png",
      "brand_logo_url": "https://example.com/audit-ready-logo.png"
    },
    {
      "id": 2,
      "type": "User",
      "text": "Compliance expert",
      "color": "#A28BFE",
      "text_color": "#18181B",
      "cta_label": "Meet our experts",
      "cta_url": "https://example.com/our-experts",
      "available_to_anyone": false,
      "position": 0,
      "brand_image_url": "https://example.com/compliance-expert-image.png",
      "brand_logo_url": "https://example.com/compliance-expert-logo.png"
    }
  ]
}

Get a badge

Return a single badge.

string

required

The ID of the badge.

Get a badge

curl "https://your-community.zapnito.com/api/v1/badges/1" \
  -H "Authorization: Token token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8"

GET https://your-community.zapnito.com/api/v1/badges/:id

{
  "badge": {
    "id": 1,
    "type": "Content",
    "text": "Audit ready",
    "color": "#88FED8",
    "text_color": "#18181B",
    "cta_label": "Read the audit checklist",
    "cta_url": "https://example.com/audit-checklist",
    "available_to_anyone": false,
    "position": 0,
    "brand_image_url": "https://example.com/audit-ready-image.png",
    "brand_logo_url": "https://example.com/audit-ready-logo.png"
  }
}

Create a badge

Create a new badge.

string

The type of record the badge is for. Accepts Content or User.

string

required

The text displayed on the badge.

string

required

The hex code for the badge colour.

string

required

The hex code for the text colour.

string

The text displayed for the call to action.

string

The URL the call to action links to.

integer

The position of the badge in badge lists. Defaults to the end of the list.

string

The URL of the brand image. Note the remote_ prefix.

string

The URL of the brand logo. Note the remote_ prefix.

Create a badge

curl -X POST "https://your-community.zapnito.com/api/v1/badges" \
  -H "Authorization: Token token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{
    "badge": {
      "type": "Content",
      "text": "Expert reviewed",
      "color": "#88FED8",
      "text_color": "#18181B",
      "cta_label": "Meet the reviewers",
      "cta_url": "https://example.com/expert-reviewers"
    }
  }'

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

{
  "badge": {
    "id": 3,
    "type": "Content",
    "text": "Expert reviewed",
    "color": "#88FED8",
    "text_color": "#18181B",
    "cta_label": "Meet the reviewers",
    "cta_url": "https://example.com/expert-reviewers",
    "available_to_anyone": false,
    "position": 0,
    "brand_image_url": "https://example.com/expert-reviewed-image.png",
    "brand_logo_url": "https://example.com/expert-reviewed-logo.png"
  }
}

Update a badge

Update an existing badge. Send only the attributes you want to change.

string

required

The ID of the badge.

string

The type of record the badge is for. Accepts Content or User.

string

The text displayed on the badge.

string

The hex code for the badge colour.

string

The hex code for the text colour.

string

The text displayed for the call to action.

string

The URL the call to action links to.

integer

The position of the badge in badge lists.

string

The URL of the brand image. Note the remote_ prefix.

string

The URL of the brand logo. Note the remote_ prefix.

Update a badge

curl -X PUT "https://your-community.zapnito.com/api/v1/badges/3" \
  -H "Authorization: Token token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{"badge": {"text": "Expert verified", "cta_label": "Meet the reviewers"}}'

PUT https://your-community.zapnito.com/api/v1/badges/:id

{
  "badge": {
    "id": 3,
    "type": "Content",
    "text": "Expert verified",
    "color": "#88FED8",
    "text_color": "#18181B",
    "cta_label": "Meet the reviewers",
    "cta_url": "https://example.com/expert-reviewers",
    "available_to_anyone": false,
    "position": 0,
    "brand_image_url": "https://example.com/expert-reviewed-image.png",
    "brand_logo_url": "https://example.com/expert-reviewed-logo.png"
  }
}

Delete a badge

Delete a badge.

string

required

The ID of the badge.

Delete a badge

curl -X DELETE "https://your-community.zapnito.com/api/v1/badges/1" \
  -H "Authorization: Token token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8"

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

{
  "message": "Badge #1 deleted"
}

Getting started

Users

Groups and organisations

Content

Channels and rooms

Badges

List badges

Get a badge

Create a badge

Update a badge

Delete a badge

​List badges

​Get a badge

​Create a badge

​Update a badge

​Delete a badge

List badges

Get a badge

Create a badge

Update a badge

Delete a badge