Skip to main content
POST
Create a custom object

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Body

application/json
belongs_to
enum<string>
required

What each of its records belongs to

Available options:
account,
contact
key
string
required

Its key: lowercase letters, digits and underscores, starting with a letter, at most 50 characters. It names the object in every path and prefixes its fields' keys (<key>__<field>), so it can't be changed

Required string length: 1 - 200
name
string
required

The name people see

Required string length: 1 - 50

Response

201 - application/json

Successful Response

custom
boolean
required

True for the tenant's own objects, false for the standard ones

fields
FieldDef · object[]
required

Its fields, as GET /v1/fields?object= lists them: standard first, each kind by key

key
string
required

Its name on the API: the {object} in /v1/objects/{object}/records

label
string
required
operations
string[]
required

What the API does with its records: list, search and get, and the writes it offers

records
string
required

The path of its records

belongs_to
enum<string> | null

A custom object's records each belong to one account, or to one contact

Available options:
account,
contact
source
string | null

Who fills a custom object's records: statisfy, or the system it syncs from (salesforce, redshift, netsuite …)