HIhillstar
card-fields

Patch a card field definition (member+)

patch/api/workspaces/{workspace_id}/card-fields/{field_id}

Request

  • Base URL
    https://api.hillstar.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.hillstar.ai/api/workspaces/{workspace_id}/card-fields/{field_id}
  • Auth
    none declared

Path parameters

workspace_idinteger required

Workspace ID

field_idinteger required

Card field ID

Request body

$schemastring uri

A URL to the JSON Schema for this object.

descriptionstring
enum_configobject
field_enumsstring[]
is_activeboolean
is_requiredboolean
labelstring
sort_orderinteger
template_idinteger

Example request

{
  "$schema": "https://example.com/api/schemas/CardFieldUpdate.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

created_atstring date-time required
descriptionstring nullable required
enum_configobject required
field_enumsstring[] required
field_keystring nullable required
field_type'text' | 'select' | 'multi_select' | 'number' | 'boolean' | 'date' | 'vote' required

Data type for a card field (EAV).

idinteger required
is_activeboolean required
is_requiredboolean required
labelstring required
sort_orderinteger required
template_idinteger nullable required
updated_atstring date-time required
workspace_idinteger required

Example response

{
  "$schema": "https://example.com/api/schemas/CardFieldRead.json"
}

Changes

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