Community Badges
Create badge Reward
deprecated
Create a reward for a badge. Badge rewards are used to provide additional incentives for members to earn badges.
POST
/
community
/
{id}
/
badge
/
{badgeId}
/
reward
Create badge reward
curl --request POST \
--url https://api.openpage.fun/v1/community/{id}/badge/{badgeId}/reward \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"name": "<string>",
"image": "<string>",
"provider": "Vault",
"vaultId": "<string>",
"contract": "<string>",
"chainId": "<string>",
"amount": [
"<string>"
],
"description": "<string>",
"endDate": "2023-11-07T05:31:56Z",
"maxSpend": 123
}
'import requests
url = "https://api.openpage.fun/v1/community/{id}/badge/{badgeId}/reward"
payload = {
"name": "<string>",
"image": "<string>",
"provider": "Vault",
"vaultId": "<string>",
"contract": "<string>",
"chainId": "<string>",
"amount": ["<string>"],
"description": "<string>",
"endDate": "2023-11-07T05:31:56Z",
"maxSpend": 123
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
image: '<string>',
provider: 'Vault',
vaultId: '<string>',
contract: '<string>',
chainId: '<string>',
amount: ['<string>'],
description: '<string>',
endDate: '2023-11-07T05:31:56Z',
maxSpend: 123
})
};
fetch('https://api.openpage.fun/v1/community/{id}/badge/{badgeId}/reward', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.openpage.fun/v1/community/{id}/badge/{badgeId}/reward",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'image' => '<string>',
'provider' => 'Vault',
'vaultId' => '<string>',
'contract' => '<string>',
'chainId' => '<string>',
'amount' => [
'<string>'
],
'description' => '<string>',
'endDate' => '2023-11-07T05:31:56Z',
'maxSpend' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.openpage.fun/v1/community/{id}/badge/{badgeId}/reward"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"image\": \"<string>\",\n \"provider\": \"Vault\",\n \"vaultId\": \"<string>\",\n \"contract\": \"<string>\",\n \"chainId\": \"<string>\",\n \"amount\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"maxSpend\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.openpage.fun/v1/community/{id}/badge/{badgeId}/reward")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"image\": \"<string>\",\n \"provider\": \"Vault\",\n \"vaultId\": \"<string>\",\n \"contract\": \"<string>\",\n \"chainId\": \"<string>\",\n \"amount\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"maxSpend\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openpage.fun/v1/community/{id}/badge/{badgeId}/reward")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"image\": \"<string>\",\n \"provider\": \"Vault\",\n \"vaultId\": \"<string>\",\n \"contract\": \"<string>\",\n \"chainId\": \"<string>\",\n \"amount\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"maxSpend\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"image": "<string>",
"provider": "Vault",
"providerImage": "<string>",
"name": "<string>",
"amount": [
123
],
"description": "<string>",
"endDate": "2023-11-07T05:31:56Z",
"maxSpend": 123,
"vaultId": "<string>",
"contract": "<string>",
"chainId": "<string>",
"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
Body
application/json
Available options:
Vault Available options:
native, erc20, erc721, erc1155, points Available options:
open, pending, sent Response
201 - application/json
Badge reward created successfully
Available options:
Vault Available options:
native, erc20, erc721, erc1155, points Available options:
open, pending, sent ⌘I
Create badge reward
curl --request POST \
--url https://api.openpage.fun/v1/community/{id}/badge/{badgeId}/reward \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"name": "<string>",
"image": "<string>",
"provider": "Vault",
"vaultId": "<string>",
"contract": "<string>",
"chainId": "<string>",
"amount": [
"<string>"
],
"description": "<string>",
"endDate": "2023-11-07T05:31:56Z",
"maxSpend": 123
}
'import requests
url = "https://api.openpage.fun/v1/community/{id}/badge/{badgeId}/reward"
payload = {
"name": "<string>",
"image": "<string>",
"provider": "Vault",
"vaultId": "<string>",
"contract": "<string>",
"chainId": "<string>",
"amount": ["<string>"],
"description": "<string>",
"endDate": "2023-11-07T05:31:56Z",
"maxSpend": 123
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
image: '<string>',
provider: 'Vault',
vaultId: '<string>',
contract: '<string>',
chainId: '<string>',
amount: ['<string>'],
description: '<string>',
endDate: '2023-11-07T05:31:56Z',
maxSpend: 123
})
};
fetch('https://api.openpage.fun/v1/community/{id}/badge/{badgeId}/reward', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.openpage.fun/v1/community/{id}/badge/{badgeId}/reward",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'image' => '<string>',
'provider' => 'Vault',
'vaultId' => '<string>',
'contract' => '<string>',
'chainId' => '<string>',
'amount' => [
'<string>'
],
'description' => '<string>',
'endDate' => '2023-11-07T05:31:56Z',
'maxSpend' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.openpage.fun/v1/community/{id}/badge/{badgeId}/reward"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"image\": \"<string>\",\n \"provider\": \"Vault\",\n \"vaultId\": \"<string>\",\n \"contract\": \"<string>\",\n \"chainId\": \"<string>\",\n \"amount\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"maxSpend\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.openpage.fun/v1/community/{id}/badge/{badgeId}/reward")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"image\": \"<string>\",\n \"provider\": \"Vault\",\n \"vaultId\": \"<string>\",\n \"contract\": \"<string>\",\n \"chainId\": \"<string>\",\n \"amount\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"maxSpend\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openpage.fun/v1/community/{id}/badge/{badgeId}/reward")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"image\": \"<string>\",\n \"provider\": \"Vault\",\n \"vaultId\": \"<string>\",\n \"contract\": \"<string>\",\n \"chainId\": \"<string>\",\n \"amount\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"maxSpend\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"image": "<string>",
"provider": "Vault",
"providerImage": "<string>",
"name": "<string>",
"amount": [
123
],
"description": "<string>",
"endDate": "2023-11-07T05:31:56Z",
"maxSpend": 123,
"vaultId": "<string>",
"contract": "<string>",
"chainId": "<string>",
"transactionHash": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"sentAt": "2023-11-07T05:31:56Z"
}