Token id
PERS-api docs (2.0.2)
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://docs.pers.ninja/_mock/swagger/
https://api.pers.ninja/v2/
Token unit management for campaign reward distribution. Defines specific token rewards that users receive when campaign participation conditions are met.
**Reward Configuration:**
• **Token Association:** Link specific token types and amounts to campaigns
• **Reward Rules:** Define token distribution rules and conditions
• **Multi-Token Support:** Configure multiple token types per campaign
• **Reward Calculation:** Set fixed or variable token amounts based on actions
• **Distribution Management:** Control how and when tokens are distributed to users
Bodyapplication/jsonrequired
token metadata incremental id for the token unit, this is used to identify the specific token metadata that should be minted
Token unit amount is the amount of tokens that the user will receive when aquiring the token unit
- Mock server
https://docs.pers.ninja/_mock/swagger/campaign-tokens/{id}
https://api.pers.ninja/v2/campaign-tokens/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.pers.ninja/_mock/swagger/campaign-tokens/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"tokenId": "string",
"tokenMetadataIncrementalId": 0,
"amount": 0,
"maxAmount": 0
}'Campaign token unit created successfully
Campaign isTestnet, this means that the campaign is running on testnet, not mainnet
Default false
Campaign trigger max geo distance to Business in meters
Campaign trigger required user info
Enum"id""email""instagramAccountId""externalId""firstName""lastName""accountAddress""publicProfile""customData""isActive"
Campaign trigger type
Enum"CLAIM_BY_USER""CLAIM_BY_SYSTEM""CLAIM_BY_BUSINESS"
Campaign trigger completion threshold. This indicates the number of completions required before the reward is granted
Campaign trigger conditions
Trigger condition type
Enum"EQUALS""NOT_EQUALS""GREATER_THAN""LESS_THAN""CONTAINS""IS_PART_OF"
Array [
Metadata of the token, this is optional and can be null in case of Point token
this is the abi of the contract, this is the interface of the contract to interact with it
this is the chain id of the chain where the token is deployed
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the symbol of the token contract, this is optional and can be null
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
This can be used to enable or disable the token for gallery
token metadata incremental id for the token unit, this is used to identify the specific token metadata that should be minted
Token unit amount is the amount of tokens that the user will receive when aquiring the token unit
Token unit max amount, this is the maximum amount of tokens that the user can receive when aquiring the token unit. This is relevant e.g. in campaigns where a user may receive token units per revenue spent etc
Campaign businesses: what businesses are involved in the campaign
A short description of the business engagement with indications what to do etc
businesses
The id of the business, this is unique and will be used to identify the business.
The email of the business, this is unique and will be used to identify the business.
The address of the business, this is the address that will be shown to the public.
The legal name of the business, this is the name that will be used for legal purposes.
The display name of the business, this is the name that will be shown to the public.
The description of the business, this is the description that will be shown to the public.
The short description of the business, this is the description that will be shown to the public.
The website of the business, this is the website that will be shown to the public.
The image of the business, this is the image that will be shown to the public.
The address of the business, this is the address that will be shown to the public.
The city of the business, this is the city that will be shown to the public.
The postal code of the business, this is the postal code that will be shown to the public.
The latitude of the business, this is the latitude that will be shown to the public.
The longitude of the business, this is the longitude that will be shown to the public.
Business type name
Business type description
Business type code
The status of the business, this is the status that will be shown to the public.
The ability to mint token for the business, this is the ability that will be shown to the public.
The ability to charge token for the business, this is the ability that will be shown to the public.
The ability to manage users for the business, this is the ability that will be shown to the public.
max per business, the maximum number of times a user can engage with the buisness in the campaign
max per day, the maximum number of times a user can engage with the buisness in the campaign per day
Response
application/json
{ "name": "string", "description": "string", "beneficiaryAccountAddress": "string", "startDate": "2019-08-24T14:15:22Z", "endDate": "2019-08-24T14:15:22Z", "imageUrl": "string", "externalUrl": "string", "id": "string", "isActive": false, "isTestnet": false, "trigger": { "name": "string", "description": "string", "maxPerDay": 0, "maxPerUser": 0, "minCooldownSeconds": 0, "maxGeoDistanceInMeters": 0, "requiredUserInfo": "id", "triggerType": "CLAIM_BY_USER", "maxMultiplier": 0, "completionThreshold": 0, "id": "string", "conditions": [ … ] }, "tokenUnits": [ [ … ] ], "businessEngagements": [ { … } ], "createdAt": "2025-10-22T19:05:50.493Z", "updatedAt": null, "order": 1, "tags": [], "countryCodeRestrictions": [ "NOT_ES", "FR" ] }
Bodyapplication/jsonrequired
token metadata incremental id for the token unit, this is used to identify the specific token metadata that should be minted
Token unit amount is the amount of tokens that the user will receive when aquiring the token unit
- Mock server
https://docs.pers.ninja/_mock/swagger/campaign-tokens/{id}/{tokenUnitId}
https://api.pers.ninja/v2/campaign-tokens/{id}/{tokenUnitId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/campaign-tokens/{id}/{tokenUnitId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"tokenId": "string",
"tokenMetadataIncrementalId": 0,
"amount": 0,
"maxAmount": 0
}'Campaign token unit updated successfully
Campaign isTestnet, this means that the campaign is running on testnet, not mainnet
Default false
Campaign trigger max geo distance to Business in meters
Campaign trigger required user info
Enum"id""email""instagramAccountId""externalId""firstName""lastName""accountAddress""publicProfile""customData""isActive"
Campaign trigger type
Enum"CLAIM_BY_USER""CLAIM_BY_SYSTEM""CLAIM_BY_BUSINESS"
Campaign trigger completion threshold. This indicates the number of completions required before the reward is granted
Campaign trigger conditions
Trigger condition type
Enum"EQUALS""NOT_EQUALS""GREATER_THAN""LESS_THAN""CONTAINS""IS_PART_OF"
Array [
Metadata of the token, this is optional and can be null in case of Point token
this is the abi of the contract, this is the interface of the contract to interact with it
this is the chain id of the chain where the token is deployed
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the symbol of the token contract, this is optional and can be null
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
This can be used to enable or disable the token for gallery
token metadata incremental id for the token unit, this is used to identify the specific token metadata that should be minted
Token unit amount is the amount of tokens that the user will receive when aquiring the token unit
Token unit max amount, this is the maximum amount of tokens that the user can receive when aquiring the token unit. This is relevant e.g. in campaigns where a user may receive token units per revenue spent etc
Campaign businesses: what businesses are involved in the campaign
A short description of the business engagement with indications what to do etc
businesses
The id of the business, this is unique and will be used to identify the business.
The email of the business, this is unique and will be used to identify the business.
The address of the business, this is the address that will be shown to the public.
The legal name of the business, this is the name that will be used for legal purposes.
The display name of the business, this is the name that will be shown to the public.
The description of the business, this is the description that will be shown to the public.
The short description of the business, this is the description that will be shown to the public.
The website of the business, this is the website that will be shown to the public.
The image of the business, this is the image that will be shown to the public.
The address of the business, this is the address that will be shown to the public.
The city of the business, this is the city that will be shown to the public.
The postal code of the business, this is the postal code that will be shown to the public.
The latitude of the business, this is the latitude that will be shown to the public.
The longitude of the business, this is the longitude that will be shown to the public.
Business type name
Business type description
Business type code
The status of the business, this is the status that will be shown to the public.
The ability to mint token for the business, this is the ability that will be shown to the public.
The ability to charge token for the business, this is the ability that will be shown to the public.
The ability to manage users for the business, this is the ability that will be shown to the public.
max per business, the maximum number of times a user can engage with the buisness in the campaign
max per day, the maximum number of times a user can engage with the buisness in the campaign per day
Response
application/json
{ "name": "string", "description": "string", "beneficiaryAccountAddress": "string", "startDate": "2019-08-24T14:15:22Z", "endDate": "2019-08-24T14:15:22Z", "imageUrl": "string", "externalUrl": "string", "id": "string", "isActive": false, "isTestnet": false, "trigger": { "name": "string", "description": "string", "maxPerDay": 0, "maxPerUser": 0, "minCooldownSeconds": 0, "maxGeoDistanceInMeters": 0, "requiredUserInfo": "id", "triggerType": "CLAIM_BY_USER", "maxMultiplier": 0, "completionThreshold": 0, "id": "string", "conditions": [ … ] }, "tokenUnits": [ [ … ] ], "businessEngagements": [ { … } ], "createdAt": "2025-10-22T19:05:50.493Z", "updatedAt": null, "order": 1, "tags": [], "countryCodeRestrictions": [ "NOT_ES", "FR" ] }
- Mock server
https://docs.pers.ninja/_mock/swagger/campaign-tokens/{id}/{tokenUnitId}
https://api.pers.ninja/v2/campaign-tokens/{id}/{tokenUnitId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.pers.ninja/_mock/swagger/campaign-tokens/{id}/{tokenUnitId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Campaign token unit removed successfully
Campaign isTestnet, this means that the campaign is running on testnet, not mainnet
Default false
Campaign trigger max geo distance to Business in meters
Campaign trigger required user info
Enum"id""email""instagramAccountId""externalId""firstName""lastName""accountAddress""publicProfile""customData""isActive"
Campaign trigger type
Enum"CLAIM_BY_USER""CLAIM_BY_SYSTEM""CLAIM_BY_BUSINESS"
Campaign trigger completion threshold. This indicates the number of completions required before the reward is granted
Campaign trigger conditions
Trigger condition type
Enum"EQUALS""NOT_EQUALS""GREATER_THAN""LESS_THAN""CONTAINS""IS_PART_OF"
Array [
Metadata of the token, this is optional and can be null in case of Point token
this is the abi of the contract, this is the interface of the contract to interact with it
this is the chain id of the chain where the token is deployed
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the symbol of the token contract, this is optional and can be null
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
This can be used to enable or disable the token for gallery
token metadata incremental id for the token unit, this is used to identify the specific token metadata that should be minted
Token unit amount is the amount of tokens that the user will receive when aquiring the token unit
Token unit max amount, this is the maximum amount of tokens that the user can receive when aquiring the token unit. This is relevant e.g. in campaigns where a user may receive token units per revenue spent etc
Campaign businesses: what businesses are involved in the campaign
A short description of the business engagement with indications what to do etc
businesses
The id of the business, this is unique and will be used to identify the business.
The email of the business, this is unique and will be used to identify the business.
The address of the business, this is the address that will be shown to the public.
The legal name of the business, this is the name that will be used for legal purposes.
The display name of the business, this is the name that will be shown to the public.
The description of the business, this is the description that will be shown to the public.
The short description of the business, this is the description that will be shown to the public.
The website of the business, this is the website that will be shown to the public.
The image of the business, this is the image that will be shown to the public.
The address of the business, this is the address that will be shown to the public.
The city of the business, this is the city that will be shown to the public.
The postal code of the business, this is the postal code that will be shown to the public.
The latitude of the business, this is the latitude that will be shown to the public.
The longitude of the business, this is the longitude that will be shown to the public.
Business type name
Business type description
Business type code
The status of the business, this is the status that will be shown to the public.
The ability to mint token for the business, this is the ability that will be shown to the public.
The ability to charge token for the business, this is the ability that will be shown to the public.
The ability to manage users for the business, this is the ability that will be shown to the public.
max per business, the maximum number of times a user can engage with the buisness in the campaign
max per day, the maximum number of times a user can engage with the buisness in the campaign per day
Response
application/json
{ "name": "string", "description": "string", "beneficiaryAccountAddress": "string", "startDate": "2019-08-24T14:15:22Z", "endDate": "2019-08-24T14:15:22Z", "imageUrl": "string", "externalUrl": "string", "id": "string", "isActive": false, "isTestnet": false, "trigger": { "name": "string", "description": "string", "maxPerDay": 0, "maxPerUser": 0, "minCooldownSeconds": 0, "maxGeoDistanceInMeters": 0, "requiredUserInfo": "id", "triggerType": "CLAIM_BY_USER", "maxMultiplier": 0, "completionThreshold": 0, "id": "string", "conditions": [ … ] }, "tokenUnits": [ [ … ] ], "businessEngagements": [ { … } ], "createdAt": "2025-10-22T19:05:50.493Z", "updatedAt": null, "order": 1, "tags": [], "countryCodeRestrictions": [ "NOT_ES", "FR" ] }