| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
This API allows you to update the custom field of the badge.
NoteFor 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.
Example request
curl --location --request PUT 'https://eu.api.capillarytech.com/api_gateway/v1/badges/customField/6995bc2a306bcf780036c094' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Basic bWFkaHVjU2YQ==' \
--header 'Cookie: _cfuvid=.WgVCi5zQoIGi4K1C9BdZuw_u5XdPxOmzWrvi.sO9xA-1771420714759-0.0.1.1-604800000' \
--data '{
"name": "CF32 date",
"isMandatory": false,
"defaultValue": "cgvhjb",
"isActive": true,
"dataType": "STRING"
}'Prerequisites
- Authentication: Basic or OAuth authentication
- Default access group
Resource information
| URI | /api_gateway/v1/badges/customField/{customFieldId} |
| HTTP method | PUT |
| Pagination supported | No |
| Rate limit | NA |
| Batch support | NA |
Request path parameter
| Parameter Name | Data Type | Description |
|---|---|---|
| customFieldId | String | Unique ID of the custom field. |
Request body parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| name* | String | Name of the custom field. |
| isMandatory | Boolean | Indicated if the custom field is mandatory. |
| defaultValue | String | Default values assigned to the custom field. |
| isActive | Boolean | Indicates if the custom field is active or not. |
| dataType* | Enum | Data type of the custom field. Supported values: INTEGER, BOOLEAN, DATE, STRING |
{
"name": "CF32 date",
"isMandatory": false,
"defaultValue": "cgvhjb",
"isActive": true,
"dataType": "STRING"
}Example response
{
"data": {
"id": "6995bc2a306bcf780036c094",
"orgId": 100737,
"name": "CF32 date",
"isMandatory": false,
"defaultValue": "cgvhjb",
"isActive": true,
"dataType": "STRING",
"createdOn": 1771420714.676000000,
"createdOnISO": "2026-02-18T13:18:34Z",
"createdBy": 75197372,
"lastUpdatedOn": 1771496603.009298000,
"lastUpdatedOnISO": "2026-02-19T10:23:23Z",
"lastUpdatedBy": 75197372
},
"errors": [],
"warnings": []
}Response parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| id | String | The unique identifier of the custom field. |
| orgId | Integer | The org ID the custom field belongs to. |
| name | String | The name of the custom field. |
| isMandatory | Boolean | Indicates if the custom field is mandatory. |
| defaultValue | String | The default value of the custom field. |
| isActive | Boolean | Indicates if the custom field is active. |
| dataType | Enum | The data type of the custom field's value. |
| createdOn | Date | The timestamp when the custom field was created. |
| createdOnISO | String | The timestamp when the custom field was created, in ISO 8601 format, returned in the server time zone. EU server example 2025-12-16T14:30:45Z → 16 December 2025, 14:30:45 (UTC) India server example 2025-12-16T14:30:45+05:30 → 16 December 2025, 14:30:45 (IST) Note: The response time zone always matches the server time zone, regardless of the time zone offset in the request. |
| createdBy | Integer | The identifier of the user who created the custom field. |
| lastUpdatedOn | Date | The timestamp when the custom field was last updated. |
| lastUpdatedOnISO | String | The timestamp when the custom field was last updated, in ISO timestamp format. The timestamp when the custom field was last updated, in ISO 8601 format, returned in the server time zone. EU server example 2025-12-16T14:30:45Z → 16 December 2025, 14:30:45 (UTC) India server example 2025-12-16T14:30:45+05:30 → 16 December 2025, 14:30:45 (IST) Note: The response time zone always matches the server time zone, regardless of the time zone offset in the request. |
| lastUpdatedBy | Integer | The identifier of the user who last updated the custom field. |
| errors | Array | A list of errors if any. |
| warnings | Array | A list of warnings if any. |
Error codes
| Error code | Description |
|---|---|
| 745 | Custom Field default value should be a Boolean |
| 744 | Custom Field default value should be a number |
| 746 | Custom Field data type cannot be changed |