Add attribute

Path Parameters

objectId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Definition of a new attribute. Type-specific configuration (e.g. options for select, decimals for number, target object for relation) is passed as additional top-level keys.

name*string

Unique machine name within the object.

label*string

Human-readable label.

type*string

Attribute type.

Value in

"text"
"richtext"
"number"
"checkbox"
"date"
"phone"
"currency"
"status"
"location"
"select"
"multiselect"
"file"
"user"
"relation"
"formula"
"rollup"
"document"

required?boolean

unique?boolean

description?string

placeholder?string

icon?string

Icon name.

defaultValue?unknown

Default value; the shape depends on the attribute type.

metadata?

[key: string]?any

Response Body

curl -X POST "https://example.com/schema/objects/string/attributes" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "label": "string",    "type": "text"  }'

Empty

Path Parameters

Request Body

Response Body

201