POST
/
community
/
{id}
/
badge
/
{badgeId}
/
reward
curl --request POST \
  --url https://api.other.page/v1/community/{id}/badge/{badgeId}/reward \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "name": "<string>",
  "image": "<string>",
  "provider": "Thank APE",
  "type": "native",
  "status": "open",
  "vaultId": "<string>",
  "contract": "<string>",
  "chainId": "<string>",
  "amount": [
    "<string>"
  ],
  "description": "<string>",
  "endDate": "2023-11-07T05:31:56Z",
  "maxSpend": 123
}'
{
  "id": "<string>",
  "image": "<string>",
  "provider": "Thank APE",
  "providerImage": "<string>",
  "name": "<string>",
  "type": "native",
  "status": "open",
  "vaultId": "<string>",
  "contract": "<string>",
  "chainId": "<string>",
  "amount": [
    123
  ],
  "description": "<string>",
  "endDate": "2023-11-07T05:31:56Z",
  "maxSpend": 123,
  "transactionHash": "<string>",
  "deletedAt": "2023-11-07T05:31:56Z",
  "sentAt": "2023-11-07T05:31:56Z"
}

To create Badge Rewards you first need to add a vault in your Portal community dashboard for each chain you want to send rewards on. View the Vault Documentation for more information.

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
id
string
required

Community ID

​
badgeId
string
required

Badge ID

Body

application/json
​
name
string
required
​
image
string
required
​
provider
enum<string>
required
Available options:
Thank APE,
Vault
​
type
enum<string>
required
Available options:
native,
erc20,
erc721,
erc1155,
points
​
status
enum<string>
required
Available options:
open,
pending,
sent
​
vaultId
string
required
​
contract
string
required
​
chainId
string
required
​
amount
string[]
required
​
description
string
required
​
endDate
string
required
​
maxSpend
number
required

Response

201 - application/json
Badge reward created successfully
​
id
string
required
​
image
string
required
​
provider
enum<string>
required
Available options:
Thank APE,
Vault
​
providerImage
string
required
​
name
string
required
​
type
enum<string>
required
Available options:
native,
erc20,
erc721,
erc1155,
points
​
status
enum<string>
required
Available options:
open,
pending,
sent
​
amount
number[]
required
​
description
string
required
​
endDate
string
required
​
maxSpend
number
required
​
vaultId
string
​
contract
string
​
chainId
string
​
transactionHash
string
​
deletedAt
string
​
sentAt
string
Get badge rewardsGet badge reward