Skip to content

Create redemption type (Admin)

Request

Create a new redemption type for system configuration. Replaces POST /redemption/admin/type

Security
authJWT
Bodyapplication/jsonrequired
namestringrequired

Redemption type name

descriptionstring

Redemption type description

imageUrlstring

Redemption type image url

baseRequiredUserFieldsArray of strings

Base required user fields for all redemptions of this type. Can include built-in field keys (email, firstName) or custom field definition UUIDs.

Default:[]
bookingRequirementobject or null(BookingRequirementConfigDTO)

Default booking requirement config for all redemptions of this type. Individual redemptions can override.

curl -i -X POST \
  https://docs.pers.ninja/_mock/swagger/redemptions/types \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "imageUrl": "string",
    "baseRequiredUserFields": [],
    "bookingRequirement": {
      "type": "active",
      "eligibleBusinessIds": [
        "string"
      ],
      "eligibleBusinessTypeIds": [
        0
      ]
    }
  }'

Responses

Redemption type created successfully

Bodyapplication/json
namestringrequired

Redemption type name

descriptionstring

Redemption type description

imageUrlstring

Redemption type image url

baseRequiredUserFieldsArray of strings

Base required user fields for all redemptions of this type. Can include built-in field keys (email, firstName) or custom field definition UUIDs.

Default:[]
bookingRequirementobject or null(BookingRequirementConfigDTO)

Default booking requirement config for all redemptions of this type. Individual redemptions can override.

idnumberrequired

Redemption type id

Response
{ "name": "string", "description": "string", "imageUrl": "string", "baseRequiredUserFields": [], "bookingRequirement": { "type": "active", "eligibleBusinessIds": [], "eligibleBusinessTypeIds": [] }, "id": 0 }