STstuut
custom-fields

Create a Custom Field

Defines a new, user-editable custom field for the given object type. The storage key is derived from the name and, like the type, is immutable once created.

post/v2/custom-fields

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Request body

object_type'consolidated_invoice' | 'contact' | 'credit_memo' | 'dispute' | 'invoice' | 'partner' | 'payment' | 'remittance' required
titlestring required
type'array' | 'boolean' | 'date' | 'datetime' | 'decimal' | 'integer' | 'number' | 'object' | 'string' | 'time' required
optionsstring[] nullable

Response

Successful Response

created_atstring date-time required
modified_atstring date-time nullable required
idstring required
keystring required

The unique key for this field.

titlestring nullable required

The human readable name for this field.

object_type'consolidated_invoice' | 'contact' | 'credit_memo' | 'dispute' | 'invoice' | 'partner' | 'payment' | 'remittance' required
type'array' | 'boolean' | 'date' | 'datetime' | 'decimal' | 'integer' | 'number' | 'object' | 'string' | 'time' nullable required

The data type for this field.

descriptionstring nullable required

A description of this field.

is_editableboolean required
optionsstring[] nullable required

The closed set of values this field accepts, or NULL when any value of type is allowed. Enforced when a value is set through the API; integration syncs write mapped values directly and are not constrained by it.

objectstring required

String representing the object's type. Objects of the same type share the same value.

Changes

No recorded changes to this operation across all 1 revision of this API.