v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Update badge custom field

put/api_gateway/v1/badges/customField/{customFieldId}

Path parameters

customFieldIdstring required

Unique ID of the custom field.

Request body

namestring required

Name of the custom field.

isMandatorystring

Indicates if the custom field is mandatory.

defaultValuestring

Default value of the custom field.

isActivestring

Indicates if the update is currently active.

dataType'INTEGER' | 'BOOLEAN' | 'DATE' | 'STRING' required

Data type of the custom field.

Response

200

Example response

{
  "data": {
    "id": "65bb446bfd3e324f2cac8871",
    "orgId": 100606,
    "name": "CF31 date",
    "defaultValue": "cgvhjb",
    "isActive": true,
    "dataType": "STRING",
    "createdOn": 1706771563.483,
    "createdBy": 75097962,
    "lastUpdatedOn": 1707979249.78829,
    "lastUpdatedBy": 75097962
  }
}