Skip to content

Update Object

PATCH
/objects/{object_slug}

PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.

Rename, archive or restore a custom object while retaining its slug and data. Archiving is refused (409 formula_dependency) while a computed field elsewhere reads it, naming every dependent the credential may see.

Authorizations

Parameters

Path Parameters

object_slug
required
string

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
description
Any of:
string
<= 2000 characters
display_attribute_slug
Any of:
string
>= 1 characters <= 100 characters /^[a-z][a-z0-9_]*$/
icon
Any of:
string
Allowed values: box briefcase building calendar flag folder globe heart layers package target users
is_archived
Any of:
boolean
plural_noun
Any of:
string
>= 1 characters <= 100 characters
singular_noun
Any of:
string
>= 1 characters <= 100 characters

Responses

200

Successful Response

object
data
required

One custom object type in the caller’s workspace.

object
description
Any of:
string
display_attribute_slug
Any of:
string
icon
Any of:
string
is_archived

Archived objects are hidden from listings.

boolean
is_system

True for objects graph8 ships; system objects cannot be deleted.

boolean
plural_noun
required

Display name for many records, e.g. “Invoices”.

string
singular_noun
required

Display name for one record, e.g. “Invoice”.

string
slug
required

Stable API slug for the object type, e.g. invoices.

string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string