Objects

Create Attribute

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.

Create a typed CRM field. Requires objects:manage and current Admin access. A computed field is checked against the schema the credential may see (an admin key included): a field it cannot see or an object it cannot read is unknown_field / unknown_relationship (422), exactly as validate answers.

post/objects/{object_slug}/attributes

Request

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

Path parameters

object_slugstring required

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

slugstring required
titlestring required
descriptionstring nullable
attribute_type'text' | 'number' | 'currency' | 'date' | 'timestamp' | 'checkbox' | 'select' | 'status' | 'email_address' | 'phone_number' | 'domain' | 'location' | 'personal_name' | 'record_reference' | 'rating' | 'actor_reference' | 'formula' required

Valid attribute types for the Custom Objects type system.

is_multiselectboolean
is_uniqueboolean
is_requiredboolean
is_default_value_enabledboolean
default_valueunknown
sort_orderinteger

Response

Successful Response

Changes

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