Page number for pagination (1-based)
/
Create campaign trigger (...
PERS-api Documentation (2.2.2)
PERS API Documentation
This RESTful API enables seamless integration of Web3 loyalty, token management, and engagement features into your applications.
Usage Guidelines:
- RESTful Design: Resources are accessed via standard HTTP methods (GET, POST, PUT, DELETE) with predictable, resource-oriented URLs.
- Authentication: Secure access is enforced via Bearer Tokens (JWT) and Project Keys (defining the Tenant context).
- Data Format: All requests and responses utilize standard JSON formatting.
Explore the modules below for detailed endpoint specifications, schemas, and testing capabilities.
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://docs.pers.ninja/_mock/swagger
https://api.pers.ninja/v2
Campaign trigger system managing activation rules and eligibility conditions. Defines when and how campaigns activate including complex condition management for sophisticated campaign logic.
Trigger Features:
•
Trigger Catalog:
Public browsing of available campaign activation triggers
•
Condition Management:
Create complex trigger conditions with multiple criteria
•
Campaign Assignment:
Link triggers to campaigns for automated activation
•
Eligibility Rules:
Define sophisticated user participation requirements
•
Event-Based Activation:
Trigger campaigns based on user actions and external events
Request
Get all available triggers for campaign configuration. Public access for catalog browsing. Use pagination parameters (page & limit) for optimal performance. Legacy support: returns array without params (deprecated - will be removed in future). Replaces GET /campaign/trigger/all
Security
projectKey
- Mock serverhttps://docs.pers.ninja/_mock/swagger/campaign-triggers
- https://api.pers.ninja/v2/campaign-triggers
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger/campaign-triggers?page=0&limit=0' \
-H 'x-project-key: YOUR_API_KEY_HERE'All available triggers retrieved
Campaign trigger completion threshold. This indicates the number of completions required before the reward is granted
Maximum claims per trigger source for this campaign. Limits how many times each individual trigger source can be used.
Source logic type defining how multiple trigger sources combine to activate the flow
Default "any"
Value"any"
Response
application/json
[ { "name": "string", "description": "string", "maxPerDay": 0, "maxPerDayPerUser": 0, "maxPerUser": 0, "minCooldownSeconds": 0, "maxGeoDistanceInMeters": 0, "requiredUserInfo": "string", "triggerType": "CLAIM_BY_USER", "maxMultiplier": 0, "completionThreshold": 0, "maxTotal": 0, "maxPerDayTotal": 0, "maxPerSource": 0, "conditions": [ … ], "sourceLogic": "any", "id": "string" } ]
Request
Create a new campaign trigger for use in campaigns. Admin-only operation. Replaces POST /campaign/admin/trigger
Security
authJWT
Campaign trigger completion threshold. This indicates the number of completions required before the reward is granted
Maximum claims per trigger source for this campaign. Limits how many times each individual trigger source can be used.
- Mock serverhttps://docs.pers.ninja/_mock/swagger/campaign-triggers
- https://api.pers.ninja/v2/campaign-triggers
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/campaign-triggers \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"description": "string",
"maxPerDay": 0,
"maxPerDayPerUser": 0,
"maxPerUser": 0,
"minCooldownSeconds": 0,
"maxGeoDistanceInMeters": 0,
"requiredUserInfo": "string",
"triggerType": "CLAIM_BY_USER",
"maxMultiplier": 0,
"completionThreshold": 0,
"maxTotal": 0,
"maxPerDayTotal": 0,
"maxPerSource": 0,
"conditions": [
{
"conditionType": "EQUALS",
"value": {},
"key": "string"
}
],
"sourceLogic": "any"
}'Campaign trigger created successfully
Campaign trigger completion threshold. This indicates the number of completions required before the reward is granted
Maximum claims per trigger source for this campaign. Limits how many times each individual trigger source can be used.
Source logic type defining how multiple trigger sources combine to activate the flow
Default "any"
Value"any"
Response
application/json
{ "name": "string", "description": "string", "maxPerDay": 0, "maxPerDayPerUser": 0, "maxPerUser": 0, "minCooldownSeconds": 0, "maxGeoDistanceInMeters": 0, "requiredUserInfo": "string", "triggerType": "CLAIM_BY_USER", "maxMultiplier": 0, "completionThreshold": 0, "maxTotal": 0, "maxPerDayTotal": 0, "maxPerSource": 0, "conditions": [ { … } ], "sourceLogic": "any", "id": "string" }
Security
projectKey
- Mock serverhttps://docs.pers.ninja/_mock/swagger/campaign-triggers/{triggerId}
- https://api.pers.ninja/v2/campaign-triggers/{triggerId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger/campaign-triggers/{triggerId}' \
-H 'x-project-key: YOUR_API_KEY_HERE'Trigger retrieved successfully
Campaign trigger completion threshold. This indicates the number of completions required before the reward is granted
Maximum claims per trigger source for this campaign. Limits how many times each individual trigger source can be used.
Source logic type defining how multiple trigger sources combine to activate the flow
Default "any"
Value"any"
Response
application/json
{ "name": "string", "description": "string", "maxPerDay": 0, "maxPerDayPerUser": 0, "maxPerUser": 0, "minCooldownSeconds": 0, "maxGeoDistanceInMeters": 0, "requiredUserInfo": "string", "triggerType": "CLAIM_BY_USER", "maxMultiplier": 0, "completionThreshold": 0, "maxTotal": 0, "maxPerDayTotal": 0, "maxPerSource": 0, "conditions": [ { … } ], "sourceLogic": "any", "id": "string" }
Request
Update an existing campaign trigger. Admin-only operation. Replaces PUT /campaign/admin/trigger/{id}
Security
authJWT
Campaign trigger completion threshold. This indicates the number of completions required before the reward is granted
Maximum claims per trigger source for this campaign. Limits how many times each individual trigger source can be used.
- Mock serverhttps://docs.pers.ninja/_mock/swagger/campaign-triggers/{triggerId}
- https://api.pers.ninja/v2/campaign-triggers/{triggerId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/campaign-triggers/{triggerId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"description": "string",
"maxPerDay": 0,
"maxPerDayPerUser": 0,
"maxPerUser": 0,
"minCooldownSeconds": 0,
"maxGeoDistanceInMeters": 0,
"requiredUserInfo": "string",
"triggerType": "CLAIM_BY_USER",
"maxMultiplier": 0,
"completionThreshold": 0,
"maxTotal": 0,
"maxPerDayTotal": 0,
"maxPerSource": 0,
"conditions": [
{
"conditionType": "EQUALS",
"value": {},
"key": "string"
}
],
"sourceLogic": "any"
}'Campaign trigger updated successfully
Campaign trigger completion threshold. This indicates the number of completions required before the reward is granted
Maximum claims per trigger source for this campaign. Limits how many times each individual trigger source can be used.
Source logic type defining how multiple trigger sources combine to activate the flow
Default "any"
Value"any"
Response
application/json
{ "name": "string", "description": "string", "maxPerDay": 0, "maxPerDayPerUser": 0, "maxPerUser": 0, "minCooldownSeconds": 0, "maxGeoDistanceInMeters": 0, "requiredUserInfo": "string", "triggerType": "CLAIM_BY_USER", "maxMultiplier": 0, "completionThreshold": 0, "maxTotal": 0, "maxPerDayTotal": 0, "maxPerSource": 0, "conditions": [ { … } ], "sourceLogic": "any", "id": "string" }
- Mock serverhttps://docs.pers.ninja/_mock/swagger/campaign-triggers/{triggerId}
- https://api.pers.ninja/v2/campaign-triggers/{triggerId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.pers.ninja/_mock/swagger/campaign-triggers/{triggerId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
true
- Mock serverhttps://docs.pers.ninja/_mock/swagger/campaign-triggers/{triggerId}/assign/{campaignId}
- https://api.pers.ninja/v2/campaign-triggers/{triggerId}/assign/{campaignId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/campaign-triggers/{triggerId}/assign/{campaignId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Trigger assigned to campaign successfully
Campaign isTestnet, this means that the campaign is running on testnet, not mainnet
Default false
Country code restrictions as an array of strings (e.g., ["NOT_ES", "FR"])
Example: ["NOT_ES","FR"]
Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated
Campaign trigger max geo distance to Business in meters
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 max total completions per day across all users
Maximum claims per trigger source for this campaign. Limits how many times each individual trigger source can be used.
Source logic type defining how multiple trigger sources combine to activate the flow
Default "any"
Value"any"
Array [
TokenDTO object
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
Array [
A short description of the business engagement with indications what to do etc
Business IDs associated with this engagement. Use CampaignDTO.included.businesses for full entities.
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
The external URL for the business engagement, e.g. a link to a website or app
Businesses (DEPRECATED: use businessIds + CampaignDTO.included.businesses instead. Will be removed in Q2 2026)
Example: [{"id":"business-uuid-1"},{"id":"business-uuid-2"}]
Trigger source IDs. Use to batch fetch or request via ?include=triggerSources
Example: ["trigger-uuid-1","trigger-uuid-2"]
Response
application/json
{ "id": "string", "name": "string", "description": "string", "beneficiaryAccountAddress": "string", "startDate": "2019-08-24T14:15:22Z", "endDate": "2019-08-24T14:15:22Z", "imageUrl": "string", "externalUrl": "string", "isActive": false, "isTestnet": false, "createdAt": "2026-03-12T10:57:54.230Z", "updatedAt": null, "order": 1, "tags": [], "countryCodeRestrictions": [ "NOT_ES", "FR" ], "trigger": { "name": "string", "description": "string", "maxPerDay": 0, "maxPerDayPerUser": 0, "maxPerUser": 0, "minCooldownSeconds": 0, "maxGeoDistanceInMeters": 0, "requiredUserInfo": "string", "triggerType": "CLAIM_BY_USER", "maxMultiplier": 0, "completionThreshold": 0, "maxTotal": 0, "maxPerDayTotal": 0, "maxPerSource": 0, "conditions": [ … ], "sourceLogic": "any", "id": "string" }, "tokenUnits": [ [ … ] ], "businessEngagements": [ [ … ] ], "triggerSourceIds": [ "trigger-uuid-1", "trigger-uuid-2" ], "included": { "triggerSources": [ … ], "businesses": [ … ] } }
- Mock serverhttps://docs.pers.ninja/_mock/swagger/campaign-triggers/{triggerId}/assign/{campaignId}
- https://api.pers.ninja/v2/campaign-triggers/{triggerId}/assign/{campaignId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.pers.ninja/_mock/swagger/campaign-triggers/{triggerId}/assign/{campaignId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Trigger removed from campaign successfully
Campaign isTestnet, this means that the campaign is running on testnet, not mainnet
Default false
Country code restrictions as an array of strings (e.g., ["NOT_ES", "FR"])
Example: ["NOT_ES","FR"]
Campaign trigger: what triggers the campaign, and what are the conditions for the trigger to be activated
Campaign trigger max geo distance to Business in meters
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 max total completions per day across all users
Maximum claims per trigger source for this campaign. Limits how many times each individual trigger source can be used.
Source logic type defining how multiple trigger sources combine to activate the flow
Default "any"
Value"any"
Array [
TokenDTO object
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
Array [
A short description of the business engagement with indications what to do etc
Business IDs associated with this engagement. Use CampaignDTO.included.businesses for full entities.
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
The external URL for the business engagement, e.g. a link to a website or app
Businesses (DEPRECATED: use businessIds + CampaignDTO.included.businesses instead. Will be removed in Q2 2026)
Example: [{"id":"business-uuid-1"},{"id":"business-uuid-2"}]
Trigger source IDs. Use to batch fetch or request via ?include=triggerSources
Example: ["trigger-uuid-1","trigger-uuid-2"]
Response
application/json
{ "id": "string", "name": "string", "description": "string", "beneficiaryAccountAddress": "string", "startDate": "2019-08-24T14:15:22Z", "endDate": "2019-08-24T14:15:22Z", "imageUrl": "string", "externalUrl": "string", "isActive": false, "isTestnet": false, "createdAt": "2026-03-12T10:57:54.230Z", "updatedAt": null, "order": 1, "tags": [], "countryCodeRestrictions": [ "NOT_ES", "FR" ], "trigger": { "name": "string", "description": "string", "maxPerDay": 0, "maxPerDayPerUser": 0, "maxPerUser": 0, "minCooldownSeconds": 0, "maxGeoDistanceInMeters": 0, "requiredUserInfo": "string", "triggerType": "CLAIM_BY_USER", "maxMultiplier": 0, "completionThreshold": 0, "maxTotal": 0, "maxPerDayTotal": 0, "maxPerSource": 0, "conditions": [ … ], "sourceLogic": "any", "id": "string" }, "tokenUnits": [ [ … ] ], "businessEngagements": [ [ … ] ], "triggerSourceIds": [ "trigger-uuid-1", "trigger-uuid-2" ], "included": { "triggerSources": [ … ], "businesses": [ … ] } }
Request
Add or remove a condition from a trigger (toggle relationship). Admin-only operation. Replaces PUT /campaign/admin/trigger/{triggerId}/condition/{conditionId}
Security
authJWT
Trigger condition type
Enum"EQUALS""NOT_EQUALS""GREATER_THAN""LESS_THAN""CONTAINS""IS_PART_OF"
- Mock serverhttps://docs.pers.ninja/_mock/swagger/campaign-triggers/{triggerId}/conditions
- https://api.pers.ninja/v2/campaign-triggers/{triggerId}/conditions
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/campaign-triggers/{triggerId}/conditions' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"conditionType": "EQUALS",
"value": {},
"key": "string"
}'Trigger condition relationship updated successfully
Campaign trigger completion threshold. This indicates the number of completions required before the reward is granted
Maximum claims per trigger source for this campaign. Limits how many times each individual trigger source can be used.
Source logic type defining how multiple trigger sources combine to activate the flow
Default "any"
Value"any"
Response
application/json
{ "name": "string", "description": "string", "maxPerDay": 0, "maxPerDayPerUser": 0, "maxPerUser": 0, "minCooldownSeconds": 0, "maxGeoDistanceInMeters": 0, "requiredUserInfo": "string", "triggerType": "CLAIM_BY_USER", "maxMultiplier": 0, "completionThreshold": 0, "maxTotal": 0, "maxPerDayTotal": 0, "maxPerSource": 0, "conditions": [ { … } ], "sourceLogic": "any", "id": "string" }