put https://{host}/api_gateway/rewards/core/v1/brand/customfield/
This API allows you to update 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 method | PUT |
| Rate limit | NA |
| Batch support | NA |
API endpoint example
https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/brand/customfield/106
Request query parameter
| Parameter | Data Type | Description |
|---|---|---|
| id* | String | Unique badge creation ID |
Request body parameter
| Parameter (Parameters marked with * are mandatory) | Data Type | Description |
|---|---|---|
| orgId | Integer | Identifier for the organization. |
| name* | String | Name of the reward. Ex: 209 |
| description* | String | Brief description of the reward. |
| isMandatory* | Boolean | Indicates if the field is mandatory. |
| scope | Enum | The 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. |
| defaultValue | String | Default value of the custom field. |
| isActive* | Boolean | Activates or disables the custom field. |
{
"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
| Parameter | Data Type | Description |
|---|---|---|
| id | Integer | Unique identifier of the custom field. |
| orgId | Integer | Identifier for the organization. |
| name | String | Name of the custom field. |
| description | String | Description of the custom field. |
| isMandatory | Boolean | Indicates if the field is mandatory. |
| isActive | Boolean | Status of the entity. |
| scope | String | Scope of the entity. |
| defaultValue | String | Default value. |
| dataType | String | Type of data. |
| createdBy | Integer | Identifier of the creator. |
| createdOn | DateTime | Creation date/time. |
| lastUpdatedBy | Integer | Identifier of the last updater. |
| lastUpdatedOn | DateTime | Last 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
}