Campaign Tags

Tenants
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Admins
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Tokens
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Campaigns
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Campaign Tags
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Campaign Organization System

Campaign tagging system for organization and categorization. Enables efficient campaign discovery through tag-based filtering and provides comprehensive tag management.

Tag Management:

•

Tag Discovery:

Browse all unique tags across campaign catalog

•

Campaign Tagging:

Associate multiple descriptive tags with campaigns

•

Tag-Based Filtering:

Enhanced campaign search and discovery via tags

•

Tag Administration:

Complete tag CRUD operations for administrators

•

Organization Tools:

Categorize campaigns by business criteria and themes

Get all unique campaign tags (Admin)

Request

Get all unique tags used across all campaigns. Admin-only operation for tag management. Set campaignId to "all" to retrieve tags from all campaigns.

Security

authJWT

Path

campaignIdstringrequired

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

Responses

All unique campaign tags retrieved

Bodyapplication/jsonArray [

string

]

Response

application/json

[
  "string"
]

Update campaign tags (Admin)

Request

Replace all tags for a campaign with new tag list. Admin-only operation. Replaces PUT /campaign/admin/{id}/tags

Security

authJWT

Path

campaignIdstringrequired

Bodyapplication/jsonrequired

tagsArray of stringsrequired

List of tags to add to campaign

Example: ["summer","discount","limited-time"]

curl -i -X PUT \
  'https://docs.pers.ninja/_mock/swagger/campaigns/{campaignId}/tags' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "tags": [
      "summer",
      "discount",
      "limited-time"
    ]
  }'

Responses

Campaign tags updated successfully

Bodyapplication/json

namestring or nullrequired

Campaign name

descriptionstring or nullrequired

Campaign description

beneficiaryAccountAddressstring or nullrequired

Campaign beneficiary account address

startDatestring or null(date-time)required

Campaign start date, default is the current date

endDatestring or null(date-time)required

Campaign end date

imageUrlstring or nullrequired

img url

externalUrlstring or nullrequired

Campaign url

idstringrequired

Campaign id

isActivebooleanrequired

Campaign isActive

Default false

isTestnetboolean

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

Default false

triggerobject or nullrequired

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

trigger.namestringrequired

Campaign trigger name

trigger.descriptionstring

Campaign trigger description

trigger.maxPerDaynumber or null

DEPRECATED - use maxPerDayPerUser: Campaign trigger max per day

trigger.maxPerDayPerUsernumber or null

Campaign trigger max per day per user

trigger.maxPerUsernumber or null

Campaign trigger max per user

trigger.minCooldownSecondsnumber or null

Campaign trigger min cooldown seconds

trigger.maxGeoDistanceInMetersnumber or null

Campaign trigger max geo distance to Business in meters

trigger.requiredUserInfostring or null

Campaign trigger required user info

trigger.triggerTypestring

Campaign trigger type

Enum"CLAIM_BY_USER""CLAIM_BY_SYSTEM""CLAIM_BY_BUSINESS"

trigger.maxMultipliernumber or null

Campaign trigger max multiplier

trigger.completionThresholdnumber or null

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

trigger.maxTotalnumber or null

Campaign trigger max total completions across all users

trigger.maxPerDayTotalnumber or null

Campaign trigger max total completions per day across all users

trigger.conditionsArray of objects(CampaignTriggerConditionDTO)

Campaign trigger conditions

trigger.sourceLogicstring

Source logic type defining how multiple trigger sources combine to activate the flow

Default "any"

Value"any"

trigger.idstringrequired

Campaign trigger id

tokenUnitsArray of objects(TokenUnitDTO)required

Array [

tokenUnits[][].idstringrequired

Token unit id

tokenUnits[][].tokenobjectrequired

TokenDTO object

tokenUnits[][].token.idstringrequired

Id of the token

tokenUnits[][].token.contractAddressstringrequired

Address of the token

tokenUnits[][].token.metadataArray of objects(TokenMetadataDTO)

Metadata of the token, this is optional and can be null in case of Point token

tokenUnits[][].token.abiobjectrequired

this is the abi of the contract, this is the interface of the contract to interact with it

tokenUnits[][].token.chainIdnumberrequired

this is the chain id of the chain where the token is deployed

tokenUnits[][].token.abiUrlobjectrequired

this is the url of the abi of the contract, to be used to fetch the abi of the contract

tokenUnits[][].token.namestring

this is the name of the token contract

tokenUnits[][].token.symbolstring

this is the symbol of the token contract, this is optional and can be null

tokenUnits[][].token.decimalsnumber

this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)

tokenUnits[][].token.isActivebooleanrequired

This can be used to enable or disable the token

tokenUnits[][].token.isGallerybooleanrequired

This can be used to enable or disable the token for gallery

tokenUnits[][].token.typestringrequired

This is the underlying web3 native type of the token contract

Enum"ERC20""ERC1155""ERC721"

tokenUnits[][].tokenMetadataIncrementalIdnumber or null

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

tokenUnits[][].amountnumberrequired

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

tokenUnits[][].maxAmountnumber or null

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

]

businessEngagementsArray of objects(CampaignBusinessEngagementDTO)required

Campaign businesses: what businesses are involved in the campaign

businessEngagements[].idstringrequired

id

businessEngagements[].shortDescriptionnumber or nullrequired

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

businessEngagements[].businessesArray of objects(BusinessDTO)required

businesses

businessEngagements[].businesses[].idstringrequired

The id of the business, this is unique and will be used to identify the business.

businessEngagements[].businesses[].emailobject or nullrequired

The email of the business, this is unique and will be used to identify the business.

businessEngagements[].businesses[].accountAddressobject or nullrequired

The address of the business, this is the address that will be shown to the public.

businessEngagements[].businesses[].businessLegalNameobject or nullrequired

The legal name of the business, this is the name that will be used for legal purposes.

businessEngagements[].businesses[].displayNameobject or nullrequired

The display name of the business, this is the name that will be shown to the public.

businessEngagements[].businesses[].descriptionobject or nullrequired

The description of the business, this is the description that will be shown to the public.

businessEngagements[].businesses[].shortDescriptionobject or nullrequired

The short description of the business, this is the description that will be shown to the public.

businessEngagements[].businesses[].websiteUrlobject or nullrequired

The website of the business, this is the website that will be shown to the public.

businessEngagements[].businesses[].imageUrlobject or nullrequired

The image of the business, this is the image that will be shown to the public.

businessEngagements[].businesses[].streetAddressobject or nullrequired

The address of the business, this is the address that will be shown to the public.

businessEngagements[].businesses[].cityobject or nullrequired

The city of the business, this is the city that will be shown to the public.

businessEngagements[].businesses[].postalCodeobject or nullrequired

The postal code of the business, this is the postal code that will be shown to the public.

businessEngagements[].businesses[].coordsLatitudeobject or nullrequired

The latitude of the business, this is the latitude that will be shown to the public.

businessEngagements[].businesses[].coordsLongitudeobject or nullrequired

The longitude of the business, this is the longitude that will be shown to the public.

businessEngagements[].businesses[].businessTypeobject or nullrequired

The business type of the business, this is the business type that will be shown to the public.

businessEngagements[].businesses[].businessType.idnumber

Business type id

businessEngagements[].businesses[].businessType.namestring or nullrequired

Business type name

businessEngagements[].businesses[].businessType.descriptionstring or nullrequired

Business type description

businessEngagements[].businesses[].businessType.codestring or nullrequired

Business type code

businessEngagements[].businesses[].businessType.iconUrlstring or nullrequired

Business type icon url

businessEngagements[].businesses[].isActivebooleanrequired

The status of the business, this is the status that will be shown to the public.

businessEngagements[].businesses[].canMintTokenbooleanrequired

The ability to mint token for the business, this is the ability that will be shown to the public.

businessEngagements[].businesses[].canChargeTokenbooleanrequired

The ability to charge token for the business, this is the ability that will be shown to the public.

businessEngagements[].businesses[].canManageUsersbooleanrequired

The ability to manage users for the business, this is the ability that will be shown to the public.

businessEngagements[].businesses[].canReceiveDonationbooleanrequired

The ability to receive donation for the business, this is the ability that will be shown to the public.

businessEngagements[].campaignIdstringrequired

Campaign id

businessEngagements[].maxPerBusinessnumber or nullrequired

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

businessEngagements[].maxPerDaynumber or nullrequired

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

businessEngagements[].externalUrlstring or nullrequired

The external URL for the business engagement, e.g. a link to a website or app

createdAtstring(date-time)required

create date

Default "2026-01-14T09:56:20.954Z"

updatedAtstring or null(date-time)required

update date

Default null

ordernumberrequired

Campaign order

Default 1

tagsArray of stringsrequired

Campaign tags

Default []

countryCodeRestrictionsobject

Country code restrictions as an array of strings (e.g., ["NOT_ES", "FR"])

Example: ["NOT_ES","FR"]

triggerSourcesArray of objects(TriggerSourceDTO)required

Array [

triggerSources[][].typestringrequired

Type of the trigger source

Enum"QR_CODE""API_WEBHOOK"

Example: "QR_CODE"

triggerSources[][].namestringrequired

Human-readable name for the trigger source

Example: "Main Entrance QR Code"

triggerSources[][].descriptionobject or null

Optional description explaining this trigger source

Example: "QR code located at the main entrance for visitor check-in"

triggerSources[][].metadataobject

Type-specific configuration and settings

Example: {"tokenConfig":{"tokenId":"1"}}

triggerSources[][].businessIdobject or null

Reference to the business that owns this trigger source. Optional - can be tenant-wide trigger sources

Example: "business-uuid-123"

triggerSources[][].idstringrequired

Unique identifier for the trigger source

Example: "source-12345"

triggerSources[][].isActivebooleanrequired

Whether this trigger source is currently active. Inactive sources won't trigger any flows

Example: true

triggerSources[][].analyticsobject or null

Usage analytics and statistics for this trigger source

triggerSources[][].createdAtobjectrequired

Timestamp when the trigger source was created

Example: "2024-01-01T12:00:00.000Z"

triggerSources[][].updatedAtobjectrequired

Timestamp when the trigger source was last updated

Example: "2024-01-10T12:00:00.000Z"

]

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,
    "maxPerDayPerUser": 0,
    "maxPerUser": 0,
    "minCooldownSeconds": 0,
    "maxGeoDistanceInMeters": 0,
    "requiredUserInfo": "string",
    "triggerType": "CLAIM_BY_USER",
    "maxMultiplier": 0,
    "completionThreshold": 0,
    "maxTotal": 0,
    "maxPerDayTotal": 0,
    "conditions": [ … ],
    "sourceLogic": "any",
    "id": "string"
  },
  "tokenUnits": [
    [ … ]
  ],
  "businessEngagements": [
    { … }
  ],
  "createdAt": "2026-01-14T09:56:20.954Z",
  "updatedAt": null,
  "order": 1,
  "tags": [],
  "countryCodeRestrictions": [
    "NOT_ES",
    "FR"
  ],
  "triggerSources": [
    []
  ]
}

Add tags to campaign (Admin)

Request

Add new tags to existing campaign tags without removing existing ones. Admin-only operation. Replaces POST /campaign/admin/{id}/tags

Security

authJWT

Path

campaignIdstringrequired

Bodyapplication/jsonrequired

tagsArray of stringsrequired

List of tags to add to campaign

Example: ["summer","discount","limited-time"]

curl -i -X POST \
  'https://docs.pers.ninja/_mock/swagger/campaigns/{campaignId}/tags' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "tags": [
      "summer",
      "discount",
      "limited-time"
    ]
  }'

Responses

Tags added to campaign successfully