Community Tokens

This is where you're gonna create and manage the tokens that give access to your Benefits

Create a Community Token

POST/api/v1/community-token

Authorization

JWT

Body

application/json

name*string

Name of the token collection

contractAddress*string

Address of the token contract from which this Community token will be associated with

startTokenIdnullable string

The initial blockchain id from the range that will be associated with this Community Token

endTokenIdnullable string

The final blockchain id from the range that will be associated with this Community Token

network*enum

Network where the contractAddress was deployed

ethereum_mainnetethereum_goerlipolygon_mainnetpolygon_mumbaicelo_alfajores

Response

201

Request

JavaScriptCurl

const response = await fetch('/api/v1/community-token', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "contractAddress": "text",
      "network": "ethereum_mainnet"
    }),
});
const data = await response.json();

Get detailed Community Token info

GET/api/v1/community-token/{id}/manage

Authorization

JWT

Path parameters

id*string

Response

200

Request

JavaScriptCurl

const response = await fetch('/api/v1/community-token/{id}/manage', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

List Community Tokens

GET/api/v1/community-token/manage

Authorization

JWT

Query parameters

Response

200

Request

JavaScriptCurl

const response = await fetch('/api/v1/community-token/manage', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Update an Community Token

PATCH/api/v1/community-token/{id}

Authorization

JWT

Path parameters

id*string

Body

application/json

namestring

Name of the token collection

contractAddressstring

Address of the token contract from which this Community token will be associated with

benefitsHasCommunityTokenobject

Response

200

Request

JavaScriptCurl

const response = await fetch('/api/v1/community-token/{id}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Remove an Community Token

DELETE/api/v1/community-token/{id}

Authorization

JWT

Path parameters

id*string

Response

200

Request

JavaScriptCurl

const response = await fetch('/api/v1/community-token/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Associate a Community Token to a Benefit

POST/api/v1/community-token/{id}/add/benefit

Authorization

JWT

Path parameters

id*string

Body

application/json

benefitIds*array of string

An array containing all the benefitIds that will be updated (added or removed) in relation to the Community Token

Response

201

Body

application/json

array of object

Request

JavaScriptCurl

const response = await fetch('/api/v1/community-token/{id}/add/benefit', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "benefitIds": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

[]

Disassociate a Community Token from a Benefit

POST/api/v1/community-token/{id}/remove/benefit

Authorization

JWT

Path parameters

id*string

Body

application/json

benefitIds*array of string

An array containing all the benefitIds that will be updated (added or removed) in relation to the Community Token

Response

201

Request

JavaScriptCurl

const response = await fetch('/api/v1/community-token/{id}/remove/benefit', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "benefitIds": [
        "text"
      ]
    }),
});
const data = await response.json();