Create custom field

This API allows you to create a custom field for the badge.

There is no limit on the number of custom fields that can be defined at an org level for badges.

๐Ÿ‘

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 .

๐Ÿšง

Warning

Custom field name should be unique and is case sensitive.

Prerequisites

  • Authentication: Basic or OAuth authentication
  • Default access group

Resource information

URIapi_gateway/v1/badges/customField
HTTP methodPOST
Pagination supportedNo
Rate limitNA
Batch supportNA

API endpoint example

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

Request body parameters

Parameter NameData TypeDescription
name*StringThe name of the custom field.
isMandatoryBooleanIndicates if the custom field is mandatory.
defaultValueStringThe default value of the custom field.
dataType*EnumThe data type of the custom field's value. Supported values: INTEGER, BOOLEAN, DATE, STRING.
{
    "name": "CF15 date",
    "isMandatory": false,
    "defaultValue": "",
    "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.
dataTypeStringThe data type of the custom field .
createdOnDateThe timestamp when the custom field was created. Timestamp in the ISO 8601 standard format format YYYY-MM-DDTHH:MM:SS.SSSZ.
createdByDateThe identifier of the user who created the custom field.
lastUpdatedOnDateThe timestamp when the custom field was last updated. Timestamp in the ISO 8601 standard format format YYYY-MM-DDTHH:MM:SS.SSSZ.
lastUpdatedByDateThe identifier of the user who last updated the custom field. Timestamp in the ISO 8601 standard format format YYYY-MM-DDTHH:MM:SS.SSSZ.
errorsObjectA list of errors if any.
warningsObjectA list of warnings if any.
{
    "data": {
        "id": "65cda4fda888ce70acd29378",
        "orgId": 100606,
        "name": "CF15 date",
        "isMandatory": false,
        "defaultValue": "",
        "isActive": true,
        "dataType": "STRING",
        "createdOn": 1707975933.629223000,
        "createdBy": 75097962,
        "lastUpdatedOn": 1707975933.629223000,
        "lastUpdatedBy": 75097962
    },
    "errors": [],
    "warnings": []
}
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!