API Documentation

Create custom field for reward

post
https://{host}/api_gateway/rewards/core/v1/brand/customfield
Body Params
string
required

Unique name identifier for the custom field.

string

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

string
required

Description for the custom field.

boolean
Defaults to false

Specify if the custom field is mandatory.

boolean
Defaults to true

Parameter to define if the custom field is active or not

string
enum
required

Specify where the additional custom fields will apply

Allowed:
string
enum
required

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

Allowed:
enumValues
array of strings

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

enumValues
Responses

Updated about 1 month ago

Language
Credentials
Basic
base64
:
URL
Request
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 1 month ago