PERS-api docs (1.8.1)

Download OpenAPI description

swagger-spec.json

swagger-spec.yaml

Overview

Servers

Mock server

https://docs.pers.ninja/_mock/swagger-spec/

https://api.pers.ninja/v1.8/

Introduction

Introducing PERS (Phygital Experience Rewards System) the ultimate SaaS of Loyalty & Reward System. Connect PERS API to your system and get ready to create multi-projects, with your own dashboard and independent database, while ensuring users data confidentiality. This structure enables:

Interoperable Rewards
Boost Customer Engagement
Simplified Management
Effortless Integration
Security and Privacy
Data-Driven Strategy

Setup Flow

This diagram illustrates the comprehensive flow of creating and connecting various components within the SaaS PERS ecosystem. It outlines the interactions and dependencies between Tokens, Campaigns, Redemptions, Purchase, and Business entities. API Flow

Claim Campaign

The Claim System Flow in SaaS PERS outlines the process through which rewards and tokens can be claimed by different entities within the system. This flow ensures that the claiming process is secure, efficient, and flexible, catering to various use cases and integration requirements. This flow ensures that the process of claiming rewards is adaptable to various scenarios, making it seamless for system administrators, business partners, and end-users to interact with the reward system efficiently.

Tenant

Operations

Token

Operations

Campaign

Operations

Description

The Campaign module in SaaS PERS enables the creation and management of multi-campaigns that users can participate in to earn tokens. This module supports a wide range of campaign types, including promotional, engagement, and loyalty campaigns, each designed to incentivize specific user behaviours. Campaigns are a strategic tool for boosting customer engagement and driving desired actions. With robust analytics and reporting features, the Campaign module allows businesses to monitor campaign performance and optimise their strategies for maximum impact. The flexibility of this module ensures that businesses can design campaigns tailored to their unique goals and customer demographics.
Key Campaign Features

Integration with External APIs: The Campaign module supports connections to over 7,000 external APIs, including CMS, CRM, Email Marketing, Events, Social Media, Product Sales, and AI. This extensive integration capability allows businesses to automate and streamline their campaign processes. Connect with Zapier
Tailored Strategies: Businesses can design campaigns to align with specific goals, such as marketing objectives, sales targets, sustainability and environmental initiatives, and productivity improvements. This flexibility ensures that campaigns are not only engaging but also strategically impactful.
Dynamic Campaign Models: The module supports various campaign types, each designed to incentivize different user behaviors. Whether it's a promotional campaign to boost short-term sales or a loyalty program to foster long-term customer engagement, the Campaign module can handle it.
User Engagement: By participating in campaigns, users can earn tokens for completing specific actions. These actions can range from social media interactions and product purchases to attending events and more, depending on the campaign's objectives.
Data-Driven Optimization: With robust analytics and reporting features, businesses can monitor the performance of their campaigns in real-time. This data-driven approach allows for continuous optimization, ensuring that campaigns achieve their desired outcomes.

List active campaigns

Request

List active campaigns

curl -i -X GET \
  https://docs.pers.ninja/_mock/swagger-spec/campaign \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Campaigns

Bodyapplication/jsonArray [

namestringrequired

Campaign name

descriptionobjectrequired

Campaign description

beneficiaryAccountAddressobjectrequired

Campaign beneficiary account address

startDateobjectrequired

Campaign start date, default is the current date

endDateobjectrequired

Campaign end date

imageUrlobjectrequired

img url

externalUrlobjectrequired

Campaign url

idstringrequired

Campaign id

isActivebooleanrequired

Campaign isActive

isTestnetboolean

Campaign isTestnet, this means that the campaign is running on testnet, not mainnet

triggerobjectrequired

Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated

tokenUnitsArray of stringsrequired

Campaign reward: what are the rewards

businessEngagementsArray of stringsrequired

Campaign businesses: what businesses are involved in the campaign

createdAtobjectrequired

create date

updatedAtobjectrequired

update date

]

Response

application/json

[
  {
    "name": "string",
    "description": {},
    "beneficiaryAccountAddress": {},
    "startDate": {},
    "endDate": {},
    "imageUrl": {},
    "externalUrl": {},
    "id": "string",
    "isActive": true,
    "isTestnet": true,
    "trigger": {},
    "tokenUnits": [ … ],
    "businessEngagements": [ … ],
    "createdAt": {},
    "updatedAt": {}
  }
]

ADMIN: List campaigns

Request

ADMIN: List campaigns

Query

activestring

Filter by active status

curl -i -X GET \
  'https://docs.pers.ninja/_mock/swagger-spec/campaign/admin?active=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Campaigns

Bodyapplication/jsonArray [

namestringrequired

Campaign name

descriptionobjectrequired

Campaign description

beneficiaryAccountAddressobjectrequired

Campaign beneficiary account address

startDateobjectrequired

Campaign start date, default is the current date

endDateobjectrequired

Campaign end date

imageUrlobjectrequired

img url

externalUrlobjectrequired

Campaign url

idstringrequired

Campaign id

isActivebooleanrequired

Campaign isActive

isTestnetboolean

Campaign isTestnet, this means that the campaign is running on testnet, not mainnet

triggerobjectrequired

Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated

tokenUnitsArray of stringsrequired

Campaign reward: what are the rewards

businessEngagementsArray of stringsrequired

Campaign businesses: what businesses are involved in the campaign

createdAtobjectrequired

create date

updatedAtobjectrequired

update date

]

Response

application/json

[
  {
    "name": "string",
    "description": {},
    "beneficiaryAccountAddress": {},
    "startDate": {},
    "endDate": {},
    "imageUrl": {},
    "externalUrl": {},
    "id": "string",
    "isActive": true,
    "isTestnet": true,
    "trigger": {},
    "tokenUnits": [ … ],
    "businessEngagements": [ … ],
    "createdAt": {},
    "updatedAt": {}
  }
]

ADMIN: Create new campaign

Request

Create new campaign

Bodyapplication/jsonrequired

namestringrequired

Campaign name

descriptionstring

Campaign description

beneficiaryAccountAddressstring

Campaign beneficiary account address

startDatestring(date-time)

Campaign start date, default is the current date

endDatestring(date-time)

Campaign end date

imageUrlstring

img url

externalUrlstring

Campaign url

curl -i -X POST \
  https://docs.pers.ninja/_mock/swagger-spec/campaign/admin \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "beneficiaryAccountAddress": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "imageUrl": "string",
    "externalUrl": "string"
  }'

Responses

Campaign created

Bodyapplication/json

namestringrequired

Campaign name

descriptionobjectrequired

Campaign description

beneficiaryAccountAddressobjectrequired

Campaign beneficiary account address

startDateobjectrequired

Campaign start date, default is the current date

endDateobjectrequired

Campaign end date

imageUrlobjectrequired

img url

externalUrlobjectrequired

Campaign url

idstringrequired

Campaign id

isActivebooleanrequired

Campaign isActive

isTestnetboolean

Campaign isTestnet, this means that the campaign is running on testnet, not mainnet

triggerobjectrequired

Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated

tokenUnitsArray of stringsrequired

Campaign reward: what are the rewards

businessEngagementsArray of stringsrequired

Campaign businesses: what businesses are involved in the campaign

createdAtobjectrequired

create date

updatedAtobjectrequired

update date

Response

application/json

{
  "name": "string",
  "description": {},
  "beneficiaryAccountAddress": {},
  "startDate": {},
  "endDate": {},
  "imageUrl": {},
  "externalUrl": {},
  "id": "string",
  "isActive": true,
  "isTestnet": true,
  "trigger": {},
  "tokenUnits": [
    "string"
  ],
  "businessEngagements": [
    "string"
  ],
  "createdAt": {},
  "updatedAt": {}
}

Get campaign

Request

Get campaign

Path

idstringrequired

curl -i -X GET \
  'https://docs.pers.ninja/_mock/swagger-spec/campaign/{id}' \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Campaign

Bodyapplication/json

namestringrequired

Campaign name

descriptionobjectrequired

Campaign description

beneficiaryAccountAddressobjectrequired

Campaign beneficiary account address

startDateobjectrequired

Campaign start date, default is the current date

endDateobjectrequired

Campaign end date

imageUrlobjectrequired

img url

externalUrlobjectrequired

Campaign url

idstringrequired

Campaign id

isActivebooleanrequired

Campaign isActive

isTestnetboolean

Campaign isTestnet, this means that the campaign is running on testnet, not mainnet

triggerobjectrequired

Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated

tokenUnitsArray of stringsrequired

Campaign reward: what are the rewards

businessEngagementsArray of stringsrequired

Campaign businesses: what businesses are involved in the campaign

createdAtobjectrequired

create date

updatedAtobjectrequired

update date

Response

application/json

{
  "name": "string",
  "description": {},
  "beneficiaryAccountAddress": {},
  "startDate": {},
  "endDate": {},
  "imageUrl": {},
  "externalUrl": {},
  "id": "string",
  "isActive": true,
  "isTestnet": true,
  "trigger": {},
  "tokenUnits": [
    "string"
  ],
  "businessEngagements": [
    "string"
  ],
  "createdAt": {},
  "updatedAt": {}
}

ADMIN: Update campaign

Request

Update campaign

Path

idstringrequired

Bodyapplication/jsonrequired

namestringrequired

Campaign name

descriptionstring

Campaign description

beneficiaryAccountAddressstring

Campaign beneficiary account address

startDatestring(date-time)

Campaign start date, default is the current date

endDatestring(date-time)

Campaign end date

imageUrlstring

img url

externalUrlstring

Campaign url

curl -i -X PUT \
  'https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "beneficiaryAccountAddress": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "imageUrl": "string",
    "externalUrl": "string"
  }'

Responses

Campaign updated

Bodyapplication/json

namestringrequired

Campaign name

descriptionobjectrequired

Campaign description

beneficiaryAccountAddressobjectrequired

Campaign beneficiary account address

startDateobjectrequired

Campaign start date, default is the current date

endDateobjectrequired

Campaign end date

imageUrlobjectrequired

img url

externalUrlobjectrequired

Campaign url

idstringrequired

Campaign id

isActivebooleanrequired

Campaign isActive

isTestnetboolean

Campaign isTestnet, this means that the campaign is running on testnet, not mainnet

triggerobjectrequired

Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated

tokenUnitsArray of stringsrequired

Campaign reward: what are the rewards

businessEngagementsArray of stringsrequired

Campaign businesses: what businesses are involved in the campaign

createdAtobjectrequired

create date

updatedAtobjectrequired

update date

Response

application/json

{
  "name": "string",
  "description": {},
  "beneficiaryAccountAddress": {},
  "startDate": {},
  "endDate": {},
  "imageUrl": {},
  "externalUrl": {},
  "id": "string",
  "isActive": true,
  "isTestnet": true,
  "trigger": {},
  "tokenUnits": [
    "string"
  ],
  "businessEngagements": [
    "string"
  ],
  "createdAt": {},
  "updatedAt": {}
}

ADMIN: Delete campaign

Request

Delete campaign

Path

idstringrequired

curl -i -X DELETE \
  'https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Campaign deleted

Bodyapplication/json

boolean

Response

application/json

true

ADMIN: Toggle activate campaign

Request

Activate / deactivate campaign

Path

idstringrequired

curl -i -X PUT \
  'https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/{id}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Campaign activated

Bodyapplication/json

namestringrequired

Campaign name

descriptionobjectrequired

Campaign description

beneficiaryAccountAddressobjectrequired

Campaign beneficiary account address

startDateobjectrequired

Campaign start date, default is the current date

endDateobjectrequired

Campaign end date

imageUrlobjectrequired

img url

externalUrlobjectrequired

Campaign url

idstringrequired

Campaign id

isActivebooleanrequired

Campaign isActive

isTestnetboolean

Campaign isTestnet, this means that the campaign is running on testnet, not mainnet

triggerobjectrequired

Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated

tokenUnitsArray of stringsrequired

Campaign reward: what are the rewards

businessEngagementsArray of stringsrequired

Campaign businesses: what businesses are involved in the campaign

createdAtobjectrequired

create date

updatedAtobjectrequired

update date

Response

application/json

{
  "name": "string",
  "description": {},
  "beneficiaryAccountAddress": {},
  "startDate": {},
  "endDate": {},
  "imageUrl": {},
  "externalUrl": {},
  "id": "string",
  "isActive": true,
  "isTestnet": true,
  "trigger": {},
  "tokenUnits": [
    "string"
  ],
  "businessEngagements": [
    "string"
  ],
  "createdAt": {},
  "updatedAt": {}
}

ADMIN: Toggle testnet campaign

Request

Set campaign to testnet or mainnet

Path

idstringrequired

curl -i -X PUT \
  'https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/{id}/environment' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Campaign set to testnet or mainnet

Bodyapplication/json

namestringrequired

Campaign name

descriptionobjectrequired

Campaign description

beneficiaryAccountAddressobjectrequired

Campaign beneficiary account address

startDateobjectrequired

Campaign start date, default is the current date

endDateobjectrequired

Campaign end date

imageUrlobjectrequired

img url

externalUrlobjectrequired

Campaign url

idstringrequired

Campaign id

isActivebooleanrequired

Campaign isActive

isTestnetboolean

Campaign isTestnet, this means that the campaign is running on testnet, not mainnet

triggerobjectrequired

Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated

tokenUnitsArray of stringsrequired

Campaign reward: what are the rewards

businessEngagementsArray of stringsrequired

Campaign businesses: what businesses are involved in the campaign

createdAtobjectrequired

create date

updatedAtobjectrequired

update date

Response

application/json

{
  "name": "string",
  "description": {},
  "beneficiaryAccountAddress": {},
  "startDate": {},
  "endDate": {},
  "imageUrl": {},
  "externalUrl": {},
  "id": "string",
  "isActive": true,
  "isTestnet": true,
  "trigger": {},
  "tokenUnits": [
    "string"
  ],
  "businessEngagements": [
    "string"
  ],
  "createdAt": {},
  "updatedAt": {}
}

ADMIN: Add campaign token

Request

Add campaign token

Path

idstringrequired

Bodyapplication/jsonrequired

tokenIdstringrequired

Token id

tokenMetadataIncrementalIdnumber

token metadata incremental id for the token unit, this is used to identify the specific token metadata that should be minted

amountnumberrequired

Token unit amount is the amount of tokens that the user will receive when aquiring the token unit

maxAmountnumber

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

curl -i -X POST \
  'https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/{id}/token-units' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "tokenId": "string",
    "tokenMetadataIncrementalId": 0,
    "amount": 0,
    "maxAmount": 0
  }'

Responses

Campaign token added

Bodyapplication/json

namestringrequired

Campaign name

descriptionobjectrequired

Campaign description

beneficiaryAccountAddressobjectrequired

Campaign beneficiary account address

startDateobjectrequired

Campaign start date, default is the current date

endDateobjectrequired

Campaign end date

imageUrlobjectrequired

img url

externalUrlobjectrequired

Campaign url

idstringrequired

Campaign id

isActivebooleanrequired

Campaign isActive

isTestnetboolean

Campaign isTestnet, this means that the campaign is running on testnet, not mainnet

triggerobjectrequired

Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated

tokenUnitsArray of stringsrequired

Campaign reward: what are the rewards

businessEngagementsArray of stringsrequired

Campaign businesses: what businesses are involved in the campaign

createdAtobjectrequired

create date

updatedAtobjectrequired

update date

Response

application/json

{
  "name": "string",
  "description": {},
  "beneficiaryAccountAddress": {},
  "startDate": {},
  "endDate": {},
  "imageUrl": {},
  "externalUrl": {},
  "id": "string",
  "isActive": true,
  "isTestnet": true,
  "trigger": {},
  "tokenUnits": [
    "string"
  ],
  "businessEngagements": [
    "string"
  ],
  "createdAt": {},
  "updatedAt": {}
}

ADMIN: Update campaign token

Request

Update campaign token

Path

idstringrequired

tokenUnitIdstringrequired

Bodyapplication/jsonrequired

tokenIdstringrequired

Token id

tokenMetadataIncrementalIdnumber

token metadata incremental id for the token unit, this is used to identify the specific token metadata that should be minted

amountnumberrequired

Token unit amount is the amount of tokens that the user will receive when aquiring the token unit

maxAmountnumber

curl -i -X PUT \
  'https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/{id}/token-units/{tokenUnitId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "tokenId": "string",
    "tokenMetadataIncrementalId": 0,
    "amount": 0,
    "maxAmount": 0
  }'

Responses

Campaign token updated

Bodyapplication/json

namestringrequired

Campaign name

descriptionobjectrequired

Campaign description

beneficiaryAccountAddressobjectrequired

Campaign beneficiary account address

startDateobjectrequired

Campaign start date, default is the current date

endDateobjectrequired

Campaign end date

imageUrlobjectrequired

img url

externalUrlobjectrequired

Campaign url

idstringrequired

Campaign id

isActivebooleanrequired

Campaign isActive

isTestnetboolean

Campaign isTestnet, this means that the campaign is running on testnet, not mainnet

triggerobjectrequired

Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated

tokenUnitsArray of stringsrequired

Campaign reward: what are the rewards

businessEngagementsArray of stringsrequired

Campaign businesses: what businesses are involved in the campaign

createdAtobjectrequired

create date

updatedAtobjectrequired

update date

Response

application/json

{
  "name": "string",
  "description": {},
  "beneficiaryAccountAddress": {},
  "startDate": {},
  "endDate": {},
  "imageUrl": {},
  "externalUrl": {},
  "id": "string",
  "isActive": true,
  "isTestnet": true,
  "trigger": {},
  "tokenUnits": [
    "string"
  ],
  "businessEngagements": [
    "string"
  ],
  "createdAt": {},
  "updatedAt": {}
}

ADMIN: Remove campaign token

Request

Remove campaign token

Path

idstringrequired

tokenUnitIdstringrequired

curl -i -X DELETE \
  'https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/{id}/token-units/{tokenUnitId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Campaign token removed

Bodyapplication/json

namestringrequired

Campaign name

descriptionobjectrequired

Campaign description

beneficiaryAccountAddressobjectrequired

Campaign beneficiary account address

startDateobjectrequired

Campaign start date, default is the current date

endDateobjectrequired

Campaign end date

imageUrlobjectrequired

img url

externalUrlobjectrequired

Campaign url

idstringrequired

Campaign id

isActivebooleanrequired

Campaign isActive

isTestnetboolean

Campaign isTestnet, this means that the campaign is running on testnet, not mainnet

triggerobjectrequired

Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated

tokenUnitsArray of stringsrequired

Campaign reward: what are the rewards

businessEngagementsArray of stringsrequired

Campaign businesses: what businesses are involved in the campaign

createdAtobjectrequired

create date

updatedAtobjectrequired

update date

Response

application/json

{
  "name": "string",
  "description": {},
  "beneficiaryAccountAddress": {},
  "startDate": {},
  "endDate": {},
  "imageUrl": {},
  "externalUrl": {},
  "id": "string",
  "isActive": true,
  "isTestnet": true,
  "trigger": {},
  "tokenUnits": [
    "string"
  ],
  "businessEngagements": [
    "string"
  ],
  "createdAt": {},
  "updatedAt": {}
}

ADMIN: Set campaign trigger

Request

Set campaign trigger

Path

idstringrequired

triggerIdstringrequired

curl -i -X PUT \
  'https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/{id}/trigger/{triggerId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Campaign trigger set

Bodyapplication/json

namestringrequired

Campaign name

descriptionobjectrequired

Campaign description

beneficiaryAccountAddressobjectrequired

Campaign beneficiary account address

startDateobjectrequired

Campaign start date, default is the current date

endDateobjectrequired

Campaign end date

imageUrlobjectrequired

img url

externalUrlobjectrequired

Campaign url

idstringrequired

Campaign id

isActivebooleanrequired

Campaign isActive

isTestnetboolean

Campaign isTestnet, this means that the campaign is running on testnet, not mainnet

triggerobjectrequired

Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated

tokenUnitsArray of stringsrequired

Campaign reward: what are the rewards

businessEngagementsArray of stringsrequired

Campaign businesses: what businesses are involved in the campaign

createdAtobjectrequired

create date

updatedAtobjectrequired

update date

Response

application/json

{
  "name": "string",
  "description": {},
  "beneficiaryAccountAddress": {},
  "startDate": {},
  "endDate": {},
  "imageUrl": {},
  "externalUrl": {},
  "id": "string",
  "isActive": true,
  "isTestnet": true,
  "trigger": {},
  "tokenUnits": [
    "string"
  ],
  "businessEngagements": [
    "string"
  ],
  "createdAt": {},
  "updatedAt": {}
}

ADMIN: Add business engagement to campaign

Request

Add business engagement to campaign

Path

idstringrequired

Bodyapplication/jsonrequired

businessIdsArray of stringsrequired

The business ids to engage with

shortDescriptionstring

A short description of the business engagement, with indications what to do etc

maxPerBussinessnumber

max per user at the business

maxPerDaynumber

max per day, the maximum number of times a user can engage with the buisness in the campaign per day

curl -i -X POST \
  'https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/{id}/business-engagement' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "businessIds": [
      "string"
    ],
    "shortDescription": "string",
    "maxPerBussiness": 0,
    "maxPerDay": 0
  }'

Responses

Business engagement added

Bodyapplication/json

namestringrequired

Campaign name

descriptionobjectrequired

Campaign description

beneficiaryAccountAddressobjectrequired

Campaign beneficiary account address

startDateobjectrequired

Campaign start date, default is the current date

endDateobjectrequired

Campaign end date

imageUrlobjectrequired

img url

externalUrlobjectrequired

Campaign url

idstringrequired

Campaign id

isActivebooleanrequired

Campaign isActive

isTestnetboolean

Campaign isTestnet, this means that the campaign is running on testnet, not mainnet

triggerobjectrequired

Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated

tokenUnitsArray of stringsrequired

Campaign reward: what are the rewards

businessEngagementsArray of stringsrequired

Campaign businesses: what businesses are involved in the campaign

createdAtobjectrequired

create date

updatedAtobjectrequired

update date

Response

application/json

{
  "name": "string",
  "description": {},
  "beneficiaryAccountAddress": {},
  "startDate": {},
  "endDate": {},
  "imageUrl": {},
  "externalUrl": {},
  "id": "string",
  "isActive": true,
  "isTestnet": true,
  "trigger": {},
  "tokenUnits": [
    "string"
  ],
  "businessEngagements": [
    "string"
  ],
  "createdAt": {},
  "updatedAt": {}
}

ADMIN: Update business engagement in campaign

Request

Update business engagement in campaign

Path

idstringrequired

businessEngagementIdstringrequired

Bodyapplication/jsonrequired

businessIdsArray of stringsrequired

The business ids to engage with

shortDescriptionstring

A short description of the business engagement, with indications what to do etc

maxPerBussinessnumber

max per user at the business

maxPerDaynumber

max per day, the maximum number of times a user can engage with the buisness in the campaign per day

curl -i -X PUT \
  'https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/{id}/business-engagement/{businessEngagementId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "businessIds": [
      "string"
    ],
    "shortDescription": "string",
    "maxPerBussiness": 0,
    "maxPerDay": 0
  }'

Responses

Business engagement updated

Bodyapplication/json

namestringrequired

Campaign name

descriptionobjectrequired

Campaign description

beneficiaryAccountAddressobjectrequired

Campaign beneficiary account address

startDateobjectrequired

Campaign start date, default is the current date

endDateobjectrequired

Campaign end date

imageUrlobjectrequired

img url

externalUrlobjectrequired

Campaign url

idstringrequired

Campaign id

isActivebooleanrequired

Campaign isActive

isTestnetboolean

Campaign isTestnet, this means that the campaign is running on testnet, not mainnet

triggerobjectrequired

Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated

tokenUnitsArray of stringsrequired

Campaign reward: what are the rewards

businessEngagementsArray of stringsrequired

Campaign businesses: what businesses are involved in the campaign

createdAtobjectrequired

create date

updatedAtobjectrequired

update date

Response

application/json

{
  "name": "string",
  "description": {},
  "beneficiaryAccountAddress": {},
  "startDate": {},
  "endDate": {},
  "imageUrl": {},
  "externalUrl": {},
  "id": "string",
  "isActive": true,
  "isTestnet": true,
  "trigger": {},
  "tokenUnits": [
    "string"
  ],
  "businessEngagements": [
    "string"
  ],
  "createdAt": {},
  "updatedAt": {}
}

ADMIN: Remove business engagement from campaign

Request

Remove business engagement from campaign

Path

idstringrequired

businessEngagementIdstringrequired

curl -i -X DELETE \
  'https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/{id}/business-engagement/{businessEngagementId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Business engagement removed

Bodyapplication/json

namestringrequired

Campaign name

descriptionobjectrequired

Campaign description

beneficiaryAccountAddressobjectrequired

Campaign beneficiary account address

startDateobjectrequired

Campaign start date, default is the current date

endDateobjectrequired

Campaign end date

imageUrlobjectrequired

img url

externalUrlobjectrequired

Campaign url

idstringrequired

Campaign id

isActivebooleanrequired

Campaign isActive

isTestnetboolean

Campaign isTestnet, this means that the campaign is running on testnet, not mainnet

triggerobjectrequired

Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated

tokenUnitsArray of stringsrequired

Campaign reward: what are the rewards

businessEngagementsArray of stringsrequired

Campaign businesses: what businesses are involved in the campaign

createdAtobjectrequired

create date

updatedAtobjectrequired

update date

Response

application/json

{
  "name": "string",
  "description": {},
  "beneficiaryAccountAddress": {},
  "startDate": {},
  "endDate": {},
  "imageUrl": {},
  "externalUrl": {},
  "id": "string",
  "isActive": true,
  "isTestnet": true,
  "trigger": {},
  "tokenUnits": [
    "string"
  ],
  "businessEngagements": [
    "string"
  ],
  "createdAt": {},
  "updatedAt": {}
}

List triggers

Request

List triggers

curl -i -X GET \
  https://docs.pers.ninja/_mock/swagger-spec/campaign/trigger/all \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Triggers

Bodyapplication/jsonArray [

namestringrequired

Campaign trigger name

descriptionstring

Campaign trigger description

maxPerDaynumber or null

Campaign trigger max per day

maxPerUsernumber or null

Campaign trigger max per user

minCooldownSecondsnumber or null

Campaign trigger min cooldown seconds

maxGeoDistanceInMetersnumber or null

Campaign trigger max geo distance to Business in meters

requiredUserInfoobject

Campaign trigger required user info

triggerTypestring

Campaign trigger type

Enum"CLAIM_BY_USER""CLAIM_BY_SYSTEM""CLAIM_BY_BUSINESS"

maxMultipliernumber or null

Campaign trigger max multiplier

completionThresholdnumber or null

Campaign trigger completion threshold. This indicates the number of completions required before the reward is granted

idstringrequired

Campaign trigger id

conditionsArray of stringsrequired

Campaign trigger conditions

]

Response

application/json

[
  {
    "name": "string",
    "description": "string",
    "maxPerDay": 0,
    "maxPerUser": 0,
    "minCooldownSeconds": 0,
    "maxGeoDistanceInMeters": 0,
    "requiredUserInfo": {},
    "triggerType": "CLAIM_BY_USER",
    "maxMultiplier": 0,
    "completionThreshold": 0,
    "id": "string",
    "conditions": [ … ]
  }
]

ADMIN: Create trigger for campaign

Request

Create trigger for campaign

Bodyapplication/jsonrequired

namestringrequired

Campaign trigger name

descriptionstring

Campaign trigger description

maxPerDaynumber or null

Campaign trigger max per day

maxPerUsernumber or null

Campaign trigger max per user

minCooldownSecondsnumber or null

Campaign trigger min cooldown seconds

maxGeoDistanceInMetersnumber or null

Campaign trigger max geo distance to Business in meters

requiredUserInfoobject

Campaign trigger required user info

triggerTypestring

Campaign trigger type

Enum"CLAIM_BY_USER""CLAIM_BY_SYSTEM""CLAIM_BY_BUSINESS"

maxMultipliernumber or null

Campaign trigger max multiplier

completionThresholdnumber or null

Campaign trigger completion threshold. This indicates the number of completions required before the reward is granted

curl -i -X POST \
  https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/trigger \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "maxPerDay": 0,
    "maxPerUser": 0,
    "minCooldownSeconds": 0,
    "maxGeoDistanceInMeters": 0,
    "requiredUserInfo": {},
    "triggerType": "CLAIM_BY_USER",
    "maxMultiplier": 0,
    "completionThreshold": 0
  }'

Responses

Campaign trigger

Bodyapplication/json

namestringrequired

Campaign trigger name

descriptionstring

Campaign trigger description

maxPerDaynumber or null

Campaign trigger max per day

maxPerUsernumber or null

Campaign trigger max per user

minCooldownSecondsnumber or null

Campaign trigger min cooldown seconds

maxGeoDistanceInMetersnumber or null

Campaign trigger max geo distance to Business in meters

requiredUserInfoobject

Campaign trigger required user info

triggerTypestring

Campaign trigger type

Enum"CLAIM_BY_USER""CLAIM_BY_SYSTEM""CLAIM_BY_BUSINESS"

maxMultipliernumber or null

Campaign trigger max multiplier

completionThresholdnumber or null

Campaign trigger completion threshold. This indicates the number of completions required before the reward is granted

idstringrequired

Campaign trigger id

conditionsArray of stringsrequired

Campaign trigger conditions

Response

application/json

{
  "name": "string",
  "description": "string",
  "maxPerDay": 0,
  "maxPerUser": 0,
  "minCooldownSeconds": 0,
  "maxGeoDistanceInMeters": 0,
  "requiredUserInfo": {},
  "triggerType": "CLAIM_BY_USER",
  "maxMultiplier": 0,
  "completionThreshold": 0,
  "id": "string",
  "conditions": [
    "string"
  ]
}

ADMIN: Update campaign trigger

Request

Update campaign trigger

Path

idstringrequired

Bodyapplication/jsonrequired

namestringrequired

Campaign trigger name

descriptionstring

Campaign trigger description

maxPerDaynumber or null

Campaign trigger max per day

maxPerUsernumber or null

Campaign trigger max per user

minCooldownSecondsnumber or null

Campaign trigger min cooldown seconds

maxGeoDistanceInMetersnumber or null

Campaign trigger max geo distance to Business in meters

requiredUserInfoobject

Campaign trigger required user info

triggerTypestring

Campaign trigger type

Enum"CLAIM_BY_USER""CLAIM_BY_SYSTEM""CLAIM_BY_BUSINESS"

maxMultipliernumber or null

Campaign trigger max multiplier

completionThresholdnumber or null

Campaign trigger completion threshold. This indicates the number of completions required before the reward is granted

curl -i -X PUT \
  'https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/trigger/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "maxPerDay": 0,
    "maxPerUser": 0,
    "minCooldownSeconds": 0,
    "maxGeoDistanceInMeters": 0,
    "requiredUserInfo": {},
    "triggerType": "CLAIM_BY_USER",
    "maxMultiplier": 0,
    "completionThreshold": 0
  }'

Responses

Campaign trigger updated

Bodyapplication/json

namestringrequired

Campaign trigger name

descriptionstring

Campaign trigger description

maxPerDaynumber or null

Campaign trigger max per day

maxPerUsernumber or null

Campaign trigger max per user

minCooldownSecondsnumber or null

Campaign trigger min cooldown seconds

maxGeoDistanceInMetersnumber or null

Campaign trigger max geo distance to Business in meters

requiredUserInfoobject

Campaign trigger required user info

triggerTypestring

Campaign trigger type

Enum"CLAIM_BY_USER""CLAIM_BY_SYSTEM""CLAIM_BY_BUSINESS"

maxMultipliernumber or null

Campaign trigger max multiplier

completionThresholdnumber or null

Campaign trigger completion threshold. This indicates the number of completions required before the reward is granted

idstringrequired

Campaign trigger id

conditionsArray of stringsrequired

Campaign trigger conditions

Response

application/json

{
  "name": "string",
  "description": "string",
  "maxPerDay": 0,
  "maxPerUser": 0,
  "minCooldownSeconds": 0,
  "maxGeoDistanceInMeters": 0,
  "requiredUserInfo": {},
  "triggerType": "CLAIM_BY_USER",
  "maxMultiplier": 0,
  "completionThreshold": 0,
  "id": "string",
  "conditions": [
    "string"
  ]
}

ADMIN: Delete campaign trigger

Request

Delete campaign trigger

Path

idstringrequired

curl -i -X DELETE \
  'https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/trigger/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Campaign trigger deleted

Bodyapplication/json

boolean

Response

application/json

true

ADMIN: Add or remove condition to campaign trigger

Request

Add or remove condition to campaign trigger

Path

triggerIdstringrequired

conditionIdstringrequired

curl -i -X PUT \
  'https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/trigger/{triggerId}/condition/{conditionId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Campaign trigger updated

Bodyapplication/json

namestringrequired

Campaign trigger name

descriptionstring

Campaign trigger description

maxPerDaynumber or null

Campaign trigger max per day

maxPerUsernumber or null

Campaign trigger max per user

minCooldownSecondsnumber or null

Campaign trigger min cooldown seconds

maxGeoDistanceInMetersnumber or null

Campaign trigger max geo distance to Business in meters

requiredUserInfoobject

Campaign trigger required user info

triggerTypestring

Campaign trigger type

Enum"CLAIM_BY_USER""CLAIM_BY_SYSTEM""CLAIM_BY_BUSINESS"

maxMultipliernumber or null

Campaign trigger max multiplier

completionThresholdnumber or null

Campaign trigger completion threshold. This indicates the number of completions required before the reward is granted

idstringrequired

Campaign trigger id

conditionsArray of stringsrequired

Campaign trigger conditions

Response

application/json

{
  "name": "string",
  "description": "string",
  "maxPerDay": 0,
  "maxPerUser": 0,
  "minCooldownSeconds": 0,
  "maxGeoDistanceInMeters": 0,
  "requiredUserInfo": {},
  "triggerType": "CLAIM_BY_USER",
  "maxMultiplier": 0,
  "completionThreshold": 0,
  "id": "string",
  "conditions": [
    "string"
  ]
}

ADMIN: Create campaign trigger condition

Request

Create campaign trigger condition

Bodyapplication/jsonrequired

conditionTypestringrequired

Trigger condition type

Enum"EQUALS""NOT_EQUALS""GREATER_THAN""LESS_THAN""CONTAINS""IS_PART_OF"

valueobjectrequired

Trigger condition value

keystringrequired

Trigger condition key

idstringrequired

curl -i -X POST \
  https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/trigger-condition \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "conditionType": "EQUALS",
    "value": {},
    "key": "string",
    "id": "string"
  }'

Responses

Campaign trigger condition created

Bodyapplication/json

conditionTypestringrequired

Trigger condition type

Enum"EQUALS""NOT_EQUALS""GREATER_THAN""LESS_THAN""CONTAINS""IS_PART_OF"

valueobjectrequired

Trigger condition value

keystringrequired

Trigger condition key

Response

application/json

{
  "conditionType": "EQUALS",
  "value": {},
  "key": "string"
}

ADMIN: Update campaign trigger condition

Request

Update campaign trigger condition

Path

idstringrequired

Bodyapplication/jsonrequired

conditionTypestringrequired

Trigger condition type

Enum"EQUALS""NOT_EQUALS""GREATER_THAN""LESS_THAN""CONTAINS""IS_PART_OF"

valueobjectrequired

Trigger condition value

keystringrequired

Trigger condition key

idstringrequired

curl -i -X PUT \
  'https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/trigger-condition/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "conditionType": "EQUALS",
    "value": {},
    "key": "string",
    "id": "string"
  }'

Responses

Campaign trigger condition updated

Bodyapplication/json

conditionTypestringrequired

Trigger condition type

Enum"EQUALS""NOT_EQUALS""GREATER_THAN""LESS_THAN""CONTAINS""IS_PART_OF"

valueobjectrequired

Trigger condition value

keystringrequired

Trigger condition key

Response

application/json

{
  "conditionType": "EQUALS",
  "value": {},
  "key": "string"
}

Claim campaign reward by System

Request

Claim campaign reward by System api key needs to be a valid tenant api key

Bodyapplication/jsonrequired

campaignIdstringrequired

The campaign id

conditionsDataobject

The campaign condition data

multipliernumber

The campaign multiplier that will be applied to the reward. Default is 1.0

businessIdstring

Business identifier

latitudenumber

geolocation latitude

longitudenumber

geolocation longitude

userIdentifierstring

The user identifier

startDatestring(date-time)

The start date of the claim

endDatestring(date-time)

The end date of the claim

idstring

The id of the user

emailstring

The email of the user

instagramAccountIdstring

The instagramAccountId of the user

externalIdstring

The externalId of the user

curl -i -X POST \
  https://docs.pers.ninja/_mock/swagger-spec/campaign/system/claim \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-project-key: YOUR_API_KEY_HERE' \
  -d '{
    "campaignId": "string",
    "conditionsData": {},
    "multiplier": 0,
    "businessId": "string",
    "latitude": 0,
    "longitude": 0,
    "userIdentifier": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "id": "string",
    "email": "string",
    "instagramAccountId": "string",
    "externalId": "string"
  }'

Responses

Campaign reward claimed

Bodyapplication/json

idstringrequired

The id of the campaign user claim

createdAtobjectrequired

The date the campaign user claim was created

userobjectrequired

The user that is claiming the campaign

user.idstringrequired

user.emailobject

user.firstNameobjectrequired

User first name

user.lastNameobjectrequired

User last name

user.externalIdobjectrequired

User external id

user.accountAddressstringrequired

User account address

user.instagramAccountIdobjectrequired

Instagram account id

user.googleAccountNameobjectrequired

Google account name

user.customDataobjectrequired

Custom data

user.publicProfileobjectrequired

Public profile data

user.isActivebooleanrequired

Is active

campaignobjectrequired

The campaign that the user is claiming

campaign.namestringrequired

Campaign name

campaign.descriptionobjectrequired

Campaign description

campaign.beneficiaryAccountAddressobjectrequired

Campaign beneficiary account address

campaign.startDateobjectrequired

Campaign start date, default is the current date

campaign.endDateobjectrequired

Campaign end date

campaign.imageUrlobjectrequired

img url

campaign.externalUrlobjectrequired

Campaign url

campaign.idstringrequired

Campaign id

campaign.isActivebooleanrequired

Campaign isActive

campaign.isTestnetboolean

Campaign isTestnet, this means that the campaign is running on testnet, not mainnet

campaign.triggerobjectrequired

Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated

campaign.tokenUnitsArray of stringsrequired

Campaign reward: what are the rewards

campaign.businessEngagementsArray of stringsrequired

Campaign businesses: what businesses are involved in the campaign

campaign.createdAtobjectrequired

create date

campaign.updatedAtobjectrequired

update date

businessobject

The business that the user claimed the campaign for

Response

application/json

{
  "id": "string",
  "createdAt": {},
  "user": {
    "id": "string",
    "email": {},
    "firstName": {},
    "lastName": {},
    "externalId": {},
    "accountAddress": "string",
    "instagramAccountId": {},
    "googleAccountName": {},
    "customData": {},
    "publicProfile": {},
    "isActive": true
  },
  "campaign": {
    "name": "string",
    "description": {},
    "beneficiaryAccountAddress": {},
    "startDate": {},
    "endDate": {},
    "imageUrl": {},
    "externalUrl": {},
    "id": "string",
    "isActive": true,
    "isTestnet": true,
    "trigger": {},
    "tokenUnits": [ … ],
    "businessEngagements": [ … ],
    "createdAt": {},
    "updatedAt": {}
  },
  "business": {
    "id": "string",
    "email": "string",
    "accountAddress": "string",
    "businessLegalName": "string",
    "displayName": "string",
    "description": "string",
    "shortDescription": "string",
    "websiteUrl": "string",
    "imageUrl": "string",
    "streetAddress": "string",
    "city": "string",
    "postalCode": "string",
    "coordsLatitude": 0,
    "coordsLongitude": 0,
    "businessType": { … },
    "isActive": true,
    "canMintToken": true,
    "canChargeToken": true,
    "canManageUsers": true,
    "canReceiveDonation": true
  }
}

BUSINESS: Claim campaign reward

Request

Claim campaign reward

Bodyapplication/jsonrequired

campaignIdstringrequired

The campaign id

conditionsDataobject

The campaign condition data

multipliernumber

The campaign multiplier that will be applied to the reward. Default is 1.0

businessIdstring

Business identifier

latitudenumber

geolocation latitude

longitudenumber

geolocation longitude

userIdentifierstring

The user identifier

startDatestring(date-time)

The start date of the claim

endDatestring(date-time)

The end date of the claim

idstring

The id of the user

emailstring

The email of the user

instagramAccountIdstring

The instagramAccountId of the user

externalIdstring

The externalId of the user

curl -i -X POST \
  https://docs.pers.ninja/_mock/swagger-spec/campaign/business/claim \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-project-key: YOUR_API_KEY_HERE' \
  -d '{
    "campaignId": "string",
    "conditionsData": {},
    "multiplier": 0,
    "businessId": "string",
    "latitude": 0,
    "longitude": 0,
    "userIdentifier": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "id": "string",
    "email": "string",
    "instagramAccountId": "string",
    "externalId": "string"
  }'

Responses

Campaign reward claimed

Bodyapplication/json

idstringrequired

The id of the campaign user claim

createdAtobjectrequired

The date the campaign user claim was created

userobjectrequired

The user that is claiming the campaign

user.idstringrequired

user.emailobject

user.firstNameobjectrequired

User first name

user.lastNameobjectrequired

User last name

user.externalIdobjectrequired

User external id

user.accountAddressstringrequired

User account address

user.instagramAccountIdobjectrequired

Instagram account id

user.googleAccountNameobjectrequired

Google account name

user.customDataobjectrequired

Custom data

user.publicProfileobjectrequired

Public profile data

user.isActivebooleanrequired

Is active

campaignobjectrequired

The campaign that the user is claiming

campaign.namestringrequired

Campaign name

campaign.descriptionobjectrequired

Campaign description

campaign.beneficiaryAccountAddressobjectrequired

Campaign beneficiary account address

campaign.startDateobjectrequired

Campaign start date, default is the current date

campaign.endDateobjectrequired

Campaign end date

campaign.imageUrlobjectrequired

img url

campaign.externalUrlobjectrequired

Campaign url

campaign.idstringrequired

Campaign id

campaign.isActivebooleanrequired

Campaign isActive

campaign.isTestnetboolean

Campaign isTestnet, this means that the campaign is running on testnet, not mainnet

campaign.triggerobjectrequired

Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated

campaign.tokenUnitsArray of stringsrequired

Campaign reward: what are the rewards

campaign.businessEngagementsArray of stringsrequired

Campaign businesses: what businesses are involved in the campaign

campaign.createdAtobjectrequired

create date

campaign.updatedAtobjectrequired

update date

businessobject

The business that the user claimed the campaign for

Response

application/json

{
  "id": "string",
  "createdAt": {},
  "user": {
    "id": "string",
    "email": {},
    "firstName": {},
    "lastName": {},
    "externalId": {},
    "accountAddress": "string",
    "instagramAccountId": {},
    "googleAccountName": {},
    "customData": {},
    "publicProfile": {},
    "isActive": true
  },
  "campaign": {
    "name": "string",
    "description": {},
    "beneficiaryAccountAddress": {},
    "startDate": {},
    "endDate": {},
    "imageUrl": {},
    "externalUrl": {},
    "id": "string",
    "isActive": true,
    "isTestnet": true,
    "trigger": {},
    "tokenUnits": [ … ],
    "businessEngagements": [ … ],
    "createdAt": {},
    "updatedAt": {}
  },
  "business": {
    "id": "string",
    "email": "string",
    "accountAddress": "string",
    "businessLegalName": "string",
    "displayName": "string",
    "description": "string",
    "shortDescription": "string",
    "websiteUrl": "string",
    "imageUrl": "string",
    "streetAddress": "string",
    "city": "string",
    "postalCode": "string",
    "coordsLatitude": 0,
    "coordsLongitude": 0,
    "businessType": { … },
    "isActive": true,
    "canMintToken": true,
    "canChargeToken": true,
    "canManageUsers": true,
    "canReceiveDonation": true
  }
}

AUTH USER: Claim campaign reward

Request

Claim campaign reward

Bodyapplication/jsonrequired

campaignIdstringrequired

The campaign id

conditionsDataobject

The campaign condition data

multipliernumber

The campaign multiplier that will be applied to the reward. Default is 1.0

businessIdstring

Business identifier

latitudenumber

geolocation latitude

longitudenumber

geolocation longitude

curl -i -X POST \
  https://docs.pers.ninja/_mock/swagger-spec/campaign/auth/claim \
  -H 'Content-Type: application/json' \
  -H 'x-project-key: YOUR_API_KEY_HERE' \
  -d '{
    "campaignId": "string",
    "conditionsData": {},
    "multiplier": 0,
    "businessId": "string",
    "latitude": 0,
    "longitude": 0
  }'

Responses

Campaign reward claimed

Bodyapplication/json

idstringrequired

The id of the campaign user claim

createdAtobjectrequired

The date the campaign user claim was created

userobjectrequired

The user that is claiming the campaign

user.idstringrequired

user.emailobject

user.firstNameobjectrequired

User first name

user.lastNameobjectrequired

User last name

user.externalIdobjectrequired

User external id

user.accountAddressstringrequired

User account address

user.instagramAccountIdobjectrequired

Instagram account id

user.googleAccountNameobjectrequired

Google account name

user.customDataobjectrequired

Custom data

user.publicProfileobjectrequired

Public profile data

user.isActivebooleanrequired

Is active

campaignobjectrequired

The campaign that the user is claiming

campaign.namestringrequired

Campaign name

campaign.descriptionobjectrequired

Campaign description

campaign.beneficiaryAccountAddressobjectrequired

Campaign beneficiary account address

campaign.startDateobjectrequired

Campaign start date, default is the current date

campaign.endDateobjectrequired

Campaign end date

campaign.imageUrlobjectrequired

img url

campaign.externalUrlobjectrequired

Campaign url

campaign.idstringrequired

Campaign id

campaign.isActivebooleanrequired

Campaign isActive

campaign.isTestnetboolean

Campaign isTestnet, this means that the campaign is running on testnet, not mainnet

campaign.triggerobjectrequired

Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated

campaign.tokenUnitsArray of stringsrequired

Campaign reward: what are the rewards

campaign.businessEngagementsArray of stringsrequired

Campaign businesses: what businesses are involved in the campaign

campaign.createdAtobjectrequired

create date

campaign.updatedAtobjectrequired

update date

businessobject

The business that the user claimed the campaign for

Response

application/json

{
  "id": "string",
  "createdAt": {},
  "user": {
    "id": "string",
    "email": {},
    "firstName": {},
    "lastName": {},
    "externalId": {},
    "accountAddress": "string",
    "instagramAccountId": {},
    "googleAccountName": {},
    "customData": {},
    "publicProfile": {},
    "isActive": true
  },
  "campaign": {
    "name": "string",
    "description": {},
    "beneficiaryAccountAddress": {},
    "startDate": {},
    "endDate": {},
    "imageUrl": {},
    "externalUrl": {},
    "id": "string",
    "isActive": true,
    "isTestnet": true,
    "trigger": {},
    "tokenUnits": [ … ],
    "businessEngagements": [ … ],
    "createdAt": {},
    "updatedAt": {}
  },
  "business": {
    "id": "string",
    "email": "string",
    "accountAddress": "string",
    "businessLegalName": "string",
    "displayName": "string",
    "description": "string",
    "shortDescription": "string",
    "websiteUrl": "string",
    "imageUrl": "string",
    "streetAddress": "string",
    "city": "string",
    "postalCode": "string",
    "coordsLatitude": 0,
    "coordsLongitude": 0,
    "businessType": { … },
    "isActive": true,
    "canMintToken": true,
    "canChargeToken": true,
    "canManageUsers": true,
    "canReceiveDonation": true
  }
}

AUTH USER: Get claim history

Request

Get claim history

curl -i -X GET \
  https://docs.pers.ninja/_mock/swagger-spec/campaign/auth/claim \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Claim history

Bodyapplication/jsonArray [

idstringrequired

The id of the campaign user claim

createdAtobjectrequired

The date the campaign user claim was created

userobjectrequired

The user that is claiming the campaign

user.idstringrequired

user.emailobject

user.firstNameobjectrequired

User first name

user.lastNameobjectrequired

User last name

user.externalIdobjectrequired

User external id

user.accountAddressstringrequired

User account address

user.instagramAccountIdobjectrequired

Instagram account id

user.googleAccountNameobjectrequired

Google account name

user.customDataobjectrequired

Custom data

user.publicProfileobjectrequired

Public profile data

user.isActivebooleanrequired

Is active

campaignobjectrequired

The campaign that the user is claiming

campaign.namestringrequired

Campaign name

campaign.descriptionobjectrequired

Campaign description

campaign.beneficiaryAccountAddressobjectrequired

Campaign beneficiary account address

campaign.startDateobjectrequired

Campaign start date, default is the current date

campaign.endDateobjectrequired

Campaign end date

campaign.imageUrlobjectrequired

img url

campaign.externalUrlobjectrequired

Campaign url

campaign.idstringrequired

Campaign id

campaign.isActivebooleanrequired

Campaign isActive

campaign.isTestnetboolean

Campaign isTestnet, this means that the campaign is running on testnet, not mainnet

campaign.triggerobjectrequired

Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated

campaign.tokenUnitsArray of stringsrequired

Campaign reward: what are the rewards

campaign.businessEngagementsArray of stringsrequired

Campaign businesses: what businesses are involved in the campaign

campaign.createdAtobjectrequired

create date

campaign.updatedAtobjectrequired

update date

businessobject

The business that the user claimed the campaign for

]

Response

application/json

[
  {
    "id": "string",
    "createdAt": {},
    "user": { … },
    "campaign": { … },
    "business": { … }
  }
]

AUTH USER: Get claim history by campaign

Request

Get claim history campaign

Path

campaignIdstringrequired

curl -i -X GET \
  'https://docs.pers.ninja/_mock/swagger-spec/campaign/auth/{campaignId}/claim' \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Claim history

Bodyapplication/jsonArray [

idstringrequired

The id of the campaign user claim

createdAtobjectrequired

The date the campaign user claim was created

userobjectrequired

The user that is claiming the campaign

user.idstringrequired

user.emailobject

user.firstNameobjectrequired

User first name

user.lastNameobjectrequired

User last name

user.externalIdobjectrequired

User external id

user.accountAddressstringrequired

User account address

user.instagramAccountIdobjectrequired

Instagram account id

user.googleAccountNameobjectrequired

Google account name

user.customDataobjectrequired

Custom data

user.publicProfileobjectrequired

Public profile data

user.isActivebooleanrequired

Is active

campaignobjectrequired

The campaign that the user is claiming

campaign.namestringrequired

Campaign name

campaign.descriptionobjectrequired

Campaign description

campaign.beneficiaryAccountAddressobjectrequired

Campaign beneficiary account address

campaign.startDateobjectrequired

Campaign start date, default is the current date

campaign.endDateobjectrequired

Campaign end date

campaign.imageUrlobjectrequired

img url

campaign.externalUrlobjectrequired

Campaign url

campaign.idstringrequired

Campaign id

campaign.isActivebooleanrequired

Campaign isActive

campaign.isTestnetboolean

Campaign isTestnet, this means that the campaign is running on testnet, not mainnet

campaign.triggerobjectrequired

Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated

campaign.tokenUnitsArray of stringsrequired

Campaign reward: what are the rewards

campaign.businessEngagementsArray of stringsrequired

Campaign businesses: what businesses are involved in the campaign

campaign.createdAtobjectrequired

create date

campaign.updatedAtobjectrequired

update date

businessobject

The business that the user claimed the campaign for

]

Response

application/json

[
  {
    "id": "string",
    "createdAt": {},
    "user": { … },
    "campaign": { … },
    "business": { … }
  }
]

ADMIN: Get all campaigns claim history

Request

Get all campaigns claim history

curl -i -X GET \
  https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/claim \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Claim history

Bodyapplication/jsonArray [

idstringrequired

The id of the campaign user claim

createdAtobjectrequired

The date the campaign user claim was created

userobjectrequired

The user that is claiming the campaign

user.idstringrequired

user.emailobject

user.firstNameobjectrequired

User first name

user.lastNameobjectrequired

User last name

user.externalIdobjectrequired

User external id

user.accountAddressstringrequired

User account address

user.instagramAccountIdobjectrequired

Instagram account id

user.googleAccountNameobjectrequired

Google account name

user.customDataobjectrequired

Custom data

user.publicProfileobjectrequired

Public profile data

user.isActivebooleanrequired

Is active

campaignobjectrequired

The campaign that the user is claiming

campaign.namestringrequired

Campaign name

campaign.descriptionobjectrequired

Campaign description

campaign.beneficiaryAccountAddressobjectrequired

Campaign beneficiary account address

campaign.startDateobjectrequired

Campaign start date, default is the current date

campaign.endDateobjectrequired

Campaign end date

campaign.imageUrlobjectrequired

img url

campaign.externalUrlobjectrequired

Campaign url

campaign.idstringrequired

Campaign id

campaign.isActivebooleanrequired

Campaign isActive

campaign.isTestnetboolean

Campaign isTestnet, this means that the campaign is running on testnet, not mainnet

campaign.triggerobjectrequired

Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated

campaign.tokenUnitsArray of stringsrequired

Campaign reward: what are the rewards

campaign.businessEngagementsArray of stringsrequired

Campaign businesses: what businesses are involved in the campaign

campaign.createdAtobjectrequired

create date

campaign.updatedAtobjectrequired

update date

businessobject

The business that the user claimed the campaign for

]

Response

application/json

[
  {
    "id": "string",
    "createdAt": {},
    "user": { … },
    "campaign": { … },
    "business": { … }
  }
]

ADMIN: Get claim history by campaign

Request

Get claim history by campaign

Path

campaignIdstringrequired

curl -i -X GET \
  'https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/{campaignId}/claim' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Claim history

Bodyapplication/jsonArray [

idstringrequired

The id of the campaign user claim

createdAtobjectrequired

The date the campaign user claim was created

userobjectrequired

The user that is claiming the campaign

user.idstringrequired

user.emailobject

user.firstNameobjectrequired

User first name

user.lastNameobjectrequired

User last name

user.externalIdobjectrequired

User external id

user.accountAddressstringrequired

User account address

user.instagramAccountIdobjectrequired

Instagram account id

user.googleAccountNameobjectrequired

Google account name

user.customDataobjectrequired

Custom data

user.publicProfileobjectrequired

Public profile data

user.isActivebooleanrequired

Is active

campaignobjectrequired

The campaign that the user is claiming

campaign.namestringrequired

Campaign name

campaign.descriptionobjectrequired

Campaign description

campaign.beneficiaryAccountAddressobjectrequired

Campaign beneficiary account address

campaign.startDateobjectrequired

Campaign start date, default is the current date

campaign.endDateobjectrequired

Campaign end date

campaign.imageUrlobjectrequired

img url

campaign.externalUrlobjectrequired

Campaign url

campaign.idstringrequired

Campaign id

campaign.isActivebooleanrequired

Campaign isActive

campaign.isTestnetboolean

Campaign isTestnet, this means that the campaign is running on testnet, not mainnet

campaign.triggerobjectrequired

Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated

campaign.tokenUnitsArray of stringsrequired

Campaign reward: what are the rewards

campaign.businessEngagementsArray of stringsrequired

Campaign businesses: what businesses are involved in the campaign

campaign.createdAtobjectrequired

create date

campaign.updatedAtobjectrequired

update date

businessobject

The business that the user claimed the campaign for

]

Response

application/json

[
  {
    "id": "string",
    "createdAt": {},
    "user": { … },
    "campaign": { … },
    "business": { … }
  }
]

ADMIN: Get all campaigns claim history

Request

Get all campaigns claim history

Path

userIdstringrequired

curl -i -X GET \
  'https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/claim/user/{userId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Claim history

Bodyapplication/jsonArray [

idstringrequired

The id of the campaign user claim

createdAtobjectrequired

The date the campaign user claim was created

userobjectrequired

The user that is claiming the campaign

user.idstringrequired

user.emailobject

user.firstNameobjectrequired

User first name

user.lastNameobjectrequired

User last name

user.externalIdobjectrequired

User external id

user.accountAddressstringrequired

User account address

user.instagramAccountIdobjectrequired

Instagram account id

user.googleAccountNameobjectrequired

Google account name

user.customDataobjectrequired

Custom data

user.publicProfileobjectrequired

Public profile data

user.isActivebooleanrequired

Is active

campaignobjectrequired

The campaign that the user is claiming

campaign.namestringrequired

Campaign name

campaign.descriptionobjectrequired

Campaign description

campaign.beneficiaryAccountAddressobjectrequired

Campaign beneficiary account address

campaign.startDateobjectrequired

Campaign start date, default is the current date

campaign.endDateobjectrequired

Campaign end date

campaign.imageUrlobjectrequired

img url

campaign.externalUrlobjectrequired

Campaign url

campaign.idstringrequired

Campaign id

campaign.isActivebooleanrequired

Campaign isActive

campaign.isTestnetboolean

Campaign isTestnet, this means that the campaign is running on testnet, not mainnet

campaign.triggerobjectrequired

Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated

campaign.tokenUnitsArray of stringsrequired

Campaign reward: what are the rewards

campaign.businessEngagementsArray of stringsrequired

Campaign businesses: what businesses are involved in the campaign

campaign.createdAtobjectrequired

create date

campaign.updatedAtobjectrequired

update date

businessobject

The business that the user claimed the campaign for

]

Response

application/json

[
  {
    "id": "string",
    "createdAt": {},
    "user": { … },
    "campaign": { … },
    "business": { … }
  }
]

ADMIN: Get all campaigns claim history

Request

Get all campaigns claim history

Path

businessIdstringrequired

curl -i -X GET \
  'https://docs.pers.ninja/_mock/swagger-spec/campaign/admin/claim/business/{businessId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Claim history

Bodyapplication/jsonArray [

idstringrequired

The id of the campaign user claim

createdAtobjectrequired

The date the campaign user claim was created

userobjectrequired

The user that is claiming the campaign

user.idstringrequired

user.emailobject

user.firstNameobjectrequired

User first name

user.lastNameobjectrequired

User last name

user.externalIdobjectrequired

User external id

user.accountAddressstringrequired

User account address

user.instagramAccountIdobjectrequired

Instagram account id

user.googleAccountNameobjectrequired

Google account name

user.customDataobjectrequired

Custom data

user.publicProfileobjectrequired

Public profile data

user.isActivebooleanrequired

Is active

campaignobjectrequired

The campaign that the user is claiming

campaign.namestringrequired

Campaign name

campaign.descriptionobjectrequired

Campaign description

campaign.beneficiaryAccountAddressobjectrequired

Campaign beneficiary account address

campaign.startDateobjectrequired

Campaign start date, default is the current date

campaign.endDateobjectrequired

Campaign end date

campaign.imageUrlobjectrequired

img url

campaign.externalUrlobjectrequired

Campaign url

campaign.idstringrequired

Campaign id

campaign.isActivebooleanrequired

Campaign isActive

campaign.isTestnetboolean

Campaign isTestnet, this means that the campaign is running on testnet, not mainnet

campaign.triggerobjectrequired

Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated

campaign.tokenUnitsArray of stringsrequired

Campaign reward: what are the rewards

campaign.businessEngagementsArray of stringsrequired

Campaign businesses: what businesses are involved in the campaign

campaign.createdAtobjectrequired

create date

campaign.updatedAtobjectrequired

update date

businessobject

The business that the user claimed the campaign for

]

Response

application/json

[
  {
    "id": "string",
    "createdAt": {},
    "user": { … },
    "campaign": { … },
    "business": { … }
  }
]

Redemption

Operations

Purchase

Operations

Business

Operations

Transaction

Operations

User

User endpoints

Operations

Admin

Operations

Auth

Operations

Web3 Contract

Operations

Web3 Chain

Operations

Root

Operations

Balance

Operations

File

Operations

PERS-api docs (1.8.1)

Introduction

Setup Flow

Claim Campaign

Tenant

Token

Campaign

Description

List active campaigns

Request

Responses

Was this helpful?

ADMIN: List campaigns

Request

Responses

Was this helpful?

ADMIN: Create new campaign

Request

Responses

Was this helpful?

Get campaign

Request

Responses

Was this helpful?

ADMIN: Update campaign

Request

Responses

Was this helpful?

ADMIN: Delete campaign

Request

Responses

Was this helpful?

ADMIN: Toggle activate campaign

Request

Responses

Was this helpful?

ADMIN: Toggle testnet campaign

Request

Responses

Was this helpful?

ADMIN: Add campaign token

Request

Responses

Was this helpful?

ADMIN: Update campaign token

Request

Responses

Was this helpful?

ADMIN: Remove campaign token

Request

Responses

Was this helpful?

ADMIN: Set campaign trigger

Request

Responses

Was this helpful?

ADMIN: Add business engagement to campaign

Request

Responses

Was this helpful?

ADMIN: Update business engagement in campaign

Request

Responses

Was this helpful?

ADMIN: Remove business engagement from campaign

Request

Responses

Was this helpful?

List triggers

Request

Responses

Was this helpful?

ADMIN: Create trigger for campaign

Request

Responses

Was this helpful?

ADMIN: Update campaign trigger

Request

Responses

Was this helpful?