Skip to content

Update a custom field

Request to update existing custom field:

PUT /api/v2/custom_fields/<field-id>.json


This API endpoint is used to administer custom fields configuration. To assign values to custom fields on call resource, use the PUT /api/v2/calls.json API endpoint.

HTTP body should contain JSON formatted profile of custom field to update.

For example:

    "custom_field": {
        "name": "New name"

Response contains HTTP status code as shown in the following list.

200 OK

Custom field has been successfully updated.

A response contains a JSON formatted client's data after update.

403 Forbidden

The request cannot be completed because API user has no permission to update custom fields

400 Bad Request

The request cannot be completed because supplied JSON object has invalid data.

When response has content type application/json, then it contains more detailed description of error in JSON format like:

``` { "error": "InvalidRecord", "description": "Record Validation errors", "details": { "name": "Such name exists already" } }