Sign in
Custom Field Values

Create or update custom field value

Creates or updates a custom field value for a card. Requires board editor permissions.

patch/cards/{cardId}/custom-field-values/customFieldGroupId:{customFieldGroupId}:customFieldId:${customFieldId}

Request

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

Path parameters

cardIdstring required
Example:1357158568008091264

ID of the card to set the custom field value for

customFieldGroupIdstring required
Example:1357158568008091265

ID of the custom field group the value belongs to

customFieldIdstring required
Example:1357158568008091266

ID of the custom field the value belongs to

Request body

contentstring required

Content/value of the custom field

Example request

{
  "content": "High Priority"
}

Response

Custom field value created or updated successfully

Example response

{
  "item": {
    "id": "1357158568008091264",
    "cardId": "1357158568008091265",
    "customFieldGroupId": "1357158568008091266",
    "customFieldId": "1357158568008091267",
    "content": "High 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.