Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Create custom field for reward

post/api_gateway/rewards/core/v1/brand/customfield

Request body

namestring required

Unique name identifier for the custom field.

orgIdstring

Unique identifier of the organisation. To retrieve the orgId, use the Get Org Details API.

descriptionstring required

Description for the custom field.

isMandatoryboolean

Specify if the custom field is mandatory.

isActiveboolean

Parameter to define if the custom field is active or not

scope'REWARD' | 'ISSUE_REWARD' | 'CATALOGUE_PROMOTION' required

Specify where the additional custom fields will apply

dataType'BOOLEAN' | 'ENUM' | 'DATE' | 'STRING' | 'INTEGER' required

Type of data for the custom field. 255 is the character limit with datatype as string

enumValuesstring[]

Object containing the enum values. This parameter is required if dataType is ENUM.

Response

200

OR
OR
OR

Example response

{
  "id": 18833,
  "orgId": 100737,
  "name": "CustomField1",
  "description": "CustomField1",
  "isActive": true,
  "scope": "REWARD",
  "dataType": "STRING",
  "createdBy": 75152721,
  "createdOn": 1741934782959,
  "createdOnDateTime": "2025-03-14T06:46:22Z",
  "lastUpdatedBy": 75152721,
  "lastUpdatedOn": 1741934782959,
  "lastUpdatedOnDateTime": "2025-03-14T06:46:22Z"
}