Update custom field

This API allows you to edit and delete a custom field.

๐Ÿ‘

Note

For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .

Prerequisites

  • Authentication: Basic or OAuth authentication details
  • Access group resource: Default

Resource information

URI/api_gateway/rewards/core/v1/brand/customfield/{id}
HTTP methodPUT
Rate limitNA
Batch supportNA

API endpoint example

https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/brand/customfield/106

Request query parameter

ParameterData TypeDescription
id*StringUnique badge creation ID

Request body parameter

Parameter
(Parameters marked with * are mandatory)
Data TypeDescription
orgIdIntegerIdentifier for the organization.
name*StringName of the reward. Ex: 209
description*StringBrief description of the reward.
isMandatory*BooleanIndicates if the field is mandatory.
scopeEnumThe scope defines where the custom fields will be applicable:

- REWARD: While creating or updating a reward.
- CATALOGUE_PROMOTION: While creating or updating a promotion.
- ISSUE REWARD: While issuing a reward.
defaultValueStringDefault value of the custom field.
isActive*BooleanIndicates if the update is currently active.
{
    "orgId": 100458,
    "name": "CF1A_update",
    "description": "CF1A",
    "isMandatory": false,
    "isActive": true,
    "scope": "REWARD",
    "defaultValue": null,
    "dataType": "STRING"
}
{
    "orgId": 100458,
    "name": "CF1A_update",
    "description": "CF1A",
    "isMandatory": false,
    "isActive": true,
    "scope": "CATALOGUE_PROMOTION",
    "defaultValue": null,
    "dataType": "STRING"
}
{
    "orgId": 100458,
    "name": "CF1A_update",
    "description": "CF1A",
    "isMandatory": false,
    "isActive": true,
    "scope": "ISSUE_REWARD",
    "defaultValue": null,
    "dataType": "STRING"
}

Response parameters

ParameterData TypeDescription
idIntegerUnique identifier of the custom field.
orgIdIntegerIdentifier for the organization.
nameStringName of the custom field.
descriptionStringDescription of the custom field.
isMandatoryBooleanIndicates if the field is mandatory.
isActiveBooleanStatus of the entity.
scopeStringScope of the entity.
defaultValueStringDefault value.
dataTypeStringType of data.
createdByIntegerIdentifier of the creator.
createdOnDateTimeCreation date/time.
lastUpdatedByIntegerIdentifier of the last updater.
lastUpdatedOnDateTimeLast update date/time .
{
    "id": 106,
    "orgId": 100458,
    "name": "CF1A_update",
    "description": "CF1A",
    "isMandatory": false,
    "isActive": true,
    "scope": "REWARD",
    "defaultValue": null,
    "dataType": "STRING",
    "createdBy": null,
    "createdOn": null,
    "lastUpdatedBy": 75086856,
    "lastUpdatedOn": null
}
{
    "id": 107,
    "orgId": 100458,
    "name": "CF1A_update",
    "description": "CF1A",
    "isMandatory": false,
    "isActive": true,
    "scope": "CATALOGUE_PROMOTION",
    "defaultValue": null,
    "dataType": "STRING",
    "createdBy": null,
    "createdOn": null,
    "lastUpdatedBy": 75086856,
    "lastUpdatedOn": null
}
{
    "id": 108,
    "orgId": 100458,
    "name": "CF1A_update",
    "description": "CF1A",
    "isMandatory": false,
    "isActive": true,
    "scope": "ISSUE_REWARD",
    "defaultValue": null,
    "dataType": "STRING",
    "createdBy": null,
    "createdOn": null,
    "lastUpdatedBy": 75086856,
    "lastUpdatedOn": null
}
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!