Skip to main content
PATCH
/
community
/
{id}
/
badge
/
{badgeId}
Update badge
curl --request PATCH \
  --url https://api.op.xyz/v1/community/{id}/badge/{badgeId} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "status": "live",
  "title": "<string>",
  "image": "<string>",
  "type": "achievement",
  "description": "<string>",
  "chainId": "11155111",
  "contract": "<string>",
  "claimEndDate": "2023-11-07T05:31:56Z",
  "maxClaims": 123,
  "tags": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "author": {
    "name": "<string>",
    "uri": "<string>"
  }
}
'

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
id
string
required

Community ID

​
badgeId
string
required

Body

application/json
​
status
enum<string>
Available options:
draft,
under_review,
approved,
rejected,
live
Example:

"live"

​
title
string
​
image
string

The image URL of the badge. Can be an IPFS url or OpenPage File.

​
type
enum<string>
Available options:
achievement,
attendance
​
description
string
​
chainId
string

The chain ID of the badge.

Example:

"11155111"

​
contract
string
​
claimEndDate
string<date-time>
​
maxClaims
number
​
tags
object[]

Array of tags. Members with matching tags are eligible to claim the badge.

​
author
object

Response

200 - undefined