Skip to content
/
Create a new business typ...

PERS-api docs (2.0.5)

Download OpenAPI description
swagger.json
swagger.yaml
Overview
Languages
Servers
Mock server

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

https://api.pers.ninja/v2/

Tenants

Operations

Admins

Operations

Tokens

Operations

Campaigns

Operations

Campaign Tags

Operations

Campaign Tokens

Operations

Campaign Triggers

Operations

Campaign Engagements

Operations

Campaign Claims

Operations

Redemptions

Operations

Purchases

Operations

Businesses

Operations

Transactions

Operations

Users

Operations

Balances

Operations

Files

Operations

Web3 Chains

Operations

Contracts

Operations

Auth

Operations

Root

Operations

Well-known

Operations

Business Types

Operations

Create a new business type

Request

Create a new business type

Security
tenantAdminJWT
Bodyapplication/jsonrequired
namestringrequired

Business type name

descriptionstringrequired

Business type description

codestring

Business type code

iconUrlstring

Business type icon url

curl -i -X POST \
  https://docs.pers.ninja/_mock/swagger/business-types \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "code": "string",
    "iconUrl": "string"
  }'

Responses

Business type created

Bodyapplication/json
idnumber

Business type id

namestring or nullrequired

Business type name

descriptionstring or nullrequired

Business type description

codestring or nullrequired

Business type code

iconUrlstring or nullrequired

Business type icon url

Response
application/json
{
  "id": 0,
  "name": "string",
  "description": "string",
  "code": "string",
  "iconUrl": "string"
}

Update a business type

Request

Update a business type

Security
tenantAdminJWT
Bodyapplication/jsonrequired
idnumber

Business type id

namestring or nullrequired

Business type name

descriptionstring or nullrequired

Business type description

codestring or nullrequired

Business type code

iconUrlstring or nullrequired

Business type icon url

curl -i -X PUT \
  https://docs.pers.ninja/_mock/swagger/business-types \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "name": "string",
    "description": "string",
    "code": "string",
    "iconUrl": "string"
  }'

Responses

Business type updated

Bodyapplication/json
idnumber

Business type id

namestring or nullrequired

Business type name

descriptionstring or nullrequired

Business type description

codestring or nullrequired

Business type code

iconUrlstring or nullrequired

Business type icon url

Response
application/json
{
  "id": 0,
  "name": "string",
  "description": "string",
  "code": "string",
  "iconUrl": "string"
}

Get all business types

Request

Get all business types

Security
projectKey
curl -i -X GET \
  https://docs.pers.ninja/_mock/swagger/business-types \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Business types found

Bodyapplication/jsonArray [
idnumber

Business type id

namestring or nullrequired

Business type name

descriptionstring or nullrequired

Business type description

codestring or nullrequired

Business type code

iconUrlstring or nullrequired

Business type icon url

]
Response
application/json
[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "code": "string",
    "iconUrl": "string"
  }
]

Delete a business type

Request

Delete a business type

Security
tenantAdminJWT
Path
idstringrequired
curl -i -X DELETE \
  'https://docs.pers.ninja/_mock/swagger/business-types/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Business type deleted

Bodyapplication/json
boolean
Response
application/json
true

Redemption Redeems

Operations

Redemption Types

Operations

Redemption Tokens

Operations