Update a property definition

PATCH

/v1/property_definitions/:id

curl -X PATCH "https://api.summerbase.com/v1/property_definitions/:id" \
  -H "Authorization: Bearer sb_..." \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Seats purchased"
  }'

const response = await fetch("https://api.summerbase.com/v1/property_definitions/:id", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer sb_...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "label": "Seats purchased"
  }),
})
const data = await response.json()

Relabel a key, or archive it. Only the source that registered the key may.

Archiving is how a key goes: the values stay and still read back, and a screen stops offering it. A key’s type cannot be changed.

Parameters

Path Parameters

required

string format: uuid

The definition’s Summerbase id.

Example

0198f1a5-7a8b-7c9d-8e0f-1a2b3c4d5e6f

Query Parameters

expand[]

Array<string>

<= 10 items

Allowed values: source

Relationships to include in the response instead of fetching separately. A dotted path expands what an expanded record can expand in turn — at most 4 deep, 10 paths a request, and never back to a record already on the path.

Request Body

application/json

object

archived

Whether the key has stopped being offered. Its values stay and still read back.

boolean

label

What a screen calls this property: the name the source that owns it gave it, or the key in words — deal_stage is Deal Stage.

string

>= 1 characters <= 255 characters

Example

{
  "label": "Seats purchased"
}

Response

Returns the property definition object.

application/json

Example

{
  "archived": false,
  "created_at": "2026-02-11T09:20:13Z",
  "id": "0198f1a5-7a8b-7c9d-8e0f-1a2b3c4d5e6f",
  "key": "seats",
  "label": "Seats",
  "object": "property_definition",
  "source_id": "0198f1a3-0c18-7d93-a6e2-1b4f9d7c3a58",
  "subject_type": "customer",
  "value_type": "number"
}