Skip to main content
Add Column
Adds one column to a custom table.
Service or master key required.

Path Parameters

string
required
Logical name of the table — pass orders, not custom_orders.

Body Parameters

string
required
Matches ^[a-zA-Z_][a-zA-Z0-9_]{0,62}$. Cannot be one of the managed column names (id, createdAt, updatedAt, deletedAt).
string
required
One of text, integer, float, boolean, timestamp, json, decimal, date, uuid.
boolean
required
Whether the column accepts NULL. Adding a non-nullable column to a table that already holds rows needs a defaultValue, or the existing rows have nothing to put in it.
string | null
Optional default, as a string.

Response

Returns 201 Created.
string
The name of the column that was added.

Error Responses

The name is one of the managed columns.
A column with that name already exists on the table.
A table may hold at most 100 columns.