Fields

Edit Field

Required scopes: field (Read and Write).

patch/fields/{fieldId}

Request

Path parameters

fieldIdinteger required

Field Identifier. Get via List Fields

Request body

op'replace' required

Patch operation to perform

path'/name' | '/description' | '/config' | '/entities' json-pointer required

A JSON Pointer as defined by <a href="https://tools.ietf.org/html/rfc6901" target="_blank">RFC 6901</a>

Response

Field was successfully updated

Example response

{
  "data": {
    "id": 2,
    "name": "Custom field",
    "slug": "custom-field",
    "description": "Custom field description",
    "type": "select",
    "entities": [
      "task"
    ],
    "createdAt": "2019-09-23T09:04:29+00:00",
    "updatedAt": "2019-09-23T09:04:29+00:00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.