Update custom field

This API allows you to update the custom field of the badge.

๐Ÿ‘

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
  • Default access group

Resource information

URI/api_gateway/v1/badges/customField/{customFieldId}
HTTP methodPUT
Pagination supportedNo
Rate limitNA
Batch supportNA

API endpoint example

https://eucrm.cc.capillarytech.com/api_gateway/v1/badges/customField/{customFieldId}

Request path parameter

Parameter NameData TypeDescription
customFieldIdStringUnique ID of the custom field.

Request body parameters

Parameter NameData TypeDescription
name*StringName of the custom field.
isMandatoryBooleanIndicated if the custom field is mandatory.
defaultValueStringDefault values assigned to the custom field.
isActiveBooleanIndicates if the custom field is active or not.
dataType*EnumData type of the custom field. Supported values: INTEGER, BOOLEAN, DATE, STRING
{
"name": "CF31 date",
"isMandatory": false,
"defaultValue": "cgvhjb",
"isActive": true,
"dataType": "STRING"
}

Response parameters

Parameter NameData TypeDescription
idStringThe unique identifier of the custom field.
orgIdIntegerThe org ID the custom field belongs to.
nameStringThe name of the custom field.
isMandatoryBooleanIndicates if the custom field is mandatory.
defaultValueStringThe default value of the custom field.
isActiveBooleanIndicates if the custom field is active.
dataTypeEnumThe data type of the custom field's value.
createdOnDateThe timestamp when the custom field was created.
createdByIntegerThe identifier of the user who created the custom field.
lastUpdatedOnDateThe timestamp when the custom field was last updated.
lastUpdatedByIntegerThe identifier of the user who last updated the custom field.
errorsArrayA list of errors if any.
warningsArrayA list of warnings if any.
{
    "data": {
        "id": "65bb446bfd3e324f2cac8871",
        "orgId": 100606,
        "name": "CF31 date",
        "isMandatory": false,
        "defaultValue": "cgvhjb",
        "isActive": true,
        "dataType": "STRING",
        "createdOn": 1706771563.483000000,
        "createdBy": 75097962,
        "lastUpdatedOn": 1707979249.788290000,
        "lastUpdatedBy": 75097962
    },
    "errors": [],
    "warnings": []
}
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!