Skip to main content
PATCH
Update an area

Authorizations

Authorization
string
header
required

A pc_… token generated from Settings > API & MCP.

Path Parameters

areaId
string<uuid>
required

Identifier of a row.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
hue
integer | null

Anodized metal hue angle from 0 to 360 degrees.

Required range: 0 <= x <= 360
icon
string | null
Required string length: 1 - 60
name
string
Required string length: 1 - 200
notes
string

Markdown: bold, italic, headings, lists, quotes, rules, links, inline code, tables and checkboxes. Do not use code blocks (```) or images: the app's editor does not support them and truncates the display from that point on.

Maximum string length: 10000
order
number

Manual position. Fractional values are valid; lower sorts first.

Response

Success.

area
object
required