Sign in
Custom Fields

Update custom field

Updates a custom field. Can update in the base custom field group (requires project manager permissions) or the custom field group (requires board editor permissions).

patch/custom-fields/{id}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/custom-fields/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Path parameters

idstring required
Example:1357158568008091264

ID of the custom field to update

Request body

positionnumber

Position of the custom field within the group

namestring

Name/title of the custom field

showOnFrontOfCardboolean

Whether to show the field on the front of cards

Example request

{
  "position": 65536,
  "name": "Priority"
}

Response

Custom field updated successfully

Example response

{
  "item": {
    "id": "1357158568008091264",
    "baseCustomFieldGroupId": "1357158568008091265",
    "customFieldGroupId": "1357158568008091266",
    "position": 65536,
    "name": "Priority",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
}

Changes

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