Objects

Update Object

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.

patch/objects/{object_slug}

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/objects/{object_slug}
  • Auth: HTTP bearer

Path parameters

object_slugstring required

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

singular_nounstring nullable
plural_nounstring nullable
is_archivedboolean nullable
descriptionstring nullable
icon'box' | 'briefcase' | 'building' | 'calendar' | 'flag' | 'folder' | 'globe' | 'heart' | 'layers' | 'package' | 'target' | 'users' nullable
display_attribute_slugstring nullable

Response

Successful Response

Changes

No recorded changes to this operation across all 2 revisions of this API.