Skip to content
Optiwork API Docs

Set one custom field value on a card

PATCH
/boards/{board}/cards/{card}/custom-fields/{definition}
curl --request PATCH \
  --url https://projects.work.optidata.cloud/api/boards/1/cards/1/custom-fields/1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "value": "opt-1" }'

Upserts the value of a single custom field. The value type must match the definition’s field type; mismatches return 422.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
board
required
integer

Board id.

card
required
integer

Card id (must belong to the board).

definition
required
integer

Custom field definition id.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
value

New value; type depends on the definition’s field type. Null clears the value.

Example
{
  "value": "opt-1"
}

Responses

Section titled “ Responses ”

200

Section titled “200”

The stored value.

Media typeapplication/json

A stored custom field value. Exactly one value_* column is populated, matching the definition’s type.

object
id
integer
card_id
integer
definition_id
integer
value_text
string | null
value_integer
integer | null
value_decimal
number | null
value_datetime
string | null format: date-time
value_boolean
boolean | null
value_json
definition

Definition of a custom field. board_id null (and is_global true) means tenant-wide.

object
id
integer
board_id
integer | null
name
string
>= 1 characters <= 60 characters
type
string
Allowed values: text number select checkbox date person
description
string | null
<= 250 characters
config

Type-specific configuration. Examples — text: {multiline, max_length, placeholder, default_value}; select: {options: [{id, label, color}]}; checkbox: {default_value}.

object | null
order
integer
is_required

Required fields block card interactions (comments, files, timers) until filled.

boolean
is_active
boolean
is_global
boolean
created_at
string format: date-time
updated_at
string format: date-time
deleted_at
string | null format: date-time
created_at
string format: date-time
updated_at
string format: date-time
Example
{
  "definition": {
    "type": "text"
  }
}

401

Section titled “401”

Missing, invalid or expired bearer passport.

Media typeapplication/json
object
error
string
Example
{
  "error": "JWT passport exception: Missing bearer token in request"
}

403

Section titled “403”

The authenticated user lacks the required board permission.

Media typeapplication/json
object
message
string
Example
{
  "message": "This action is unauthorized."
}

404

Section titled “404”

Resource not found, or a nested resource does not belong to its parent in the path.

Media typeapplication/json
object
message
string
Example
{
  "message": "Not found."
}

422

Section titled “422”

Validation failed.

Media typeapplication/json
object
message

First validation error message.

string
errors

Map of field name → list of error messages.

object
key
additional properties
Array<string>
Example
{
  "message": "The name field is required.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}