Add Custom Field

All API requests should contain authorization headers.

Request

POST /customFields

Query Parameters

This endpoint doesn't require query parameters.

Request Body

Request body should contain custom field object. The id field should be equal to 0 or left unset.

If the value field is set it will be ignored.

{
    "assignedCategoryIds": null,
    "defaultValue": null,
    "id": 0,
    "isHidden": false,
    "isRequired": false,
    "isSensitiveData": false,
    "name": "Client Comment",
    "placeholder": "Client Comment",
    "possibleValues": null,
    "type": "text_input"
}

Response

{
    "data": {
        "assignedCategoryIds": [],
        "defaultValue": null,
        "id": 26707,
        "isHidden": false,
        "isRequired": false,
        "isSensitiveData": false,
        "name": "Client Comment",
        "placeholder": "Client Comment",
        "possibleValues": [],
        "type": "text_input"
    },
    "errorCode": -1,
    "errorText": null
}

Data field has type of Custom Field object.

Last updated