Skip to main content
POST
Create an object
Requires objects:write, a verified administrator, and Objects enabled for the workspace. Creation adds an empty definition. It does not automatically add a Name attribute or create records. Add attributes from the Object’s Attributes tab in Manage.

Parameters

string
required
Immutable key beginning with workspace., followed by a lowercase letter and lowercase letters, numbers, or underscores. Maximum 73 characters including the prefix. Must be unique within the workspace.
string
required
Name for one record. Maximum 100 characters.
string
required
Name for the collection. Maximum 100 characters.
string
Defaults to regular/cube. Supported icons are:regular/cube, regular/users, regular/user, regular/building, regular/briefcase, regular/id-card, regular/handshake, regular/globe, regular/laptop, regular/mobile-screen, regular/server, regular/database, regular/code, regular/gear, regular/wrench, regular/camera, regular/folder, regular/file-lines, regular/file-contract, regular/clipboard-check, regular/graduation-cap, regular/book, regular/certificate, regular/lightbulb, regular/calendar, regular/clock, regular/location-dot, regular/plane, regular/truck, regular/box-archive, regular/tag, regular/cart-shopping, regular/wallet, regular/credit-card, regular/coins, regular/receipt, regular/chart-line, regular/shield-check, regular/heart, regular/leaf.
string
Optional description. Maximum 1,000 characters.

Returns

Returns the created Object definition.