Create a custom column

post

https://api.cardda.com/v1/custom_columns

Creates a custom column. Requires the custom_columns_create permission on the company.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Payload to create a custom column. Requires the custom_columns_create permission on the
company. company_id must be supplied in the body — the controller does not read it from
the company-id header for this action.

label

string

required

Human-facing label.

internal_name

string

required

Internal name used for programmatic references.

field

string

required

The field/input type of the column.

company_id

uuid

required

The owning company id. Required in the body (not read from the company-id header).

source_table

string

The source table the column reads from, when applicable.

default_value

string

Default value applied when no value is set.

applicable_models

array of strings

required

applicable_models*

options

array of objects

options

Headers

company-id

uuid

required

UUID of the company on whose behalf the request is made. Required for every Accounting endpoint.
See The company-id header for details on how to obtain
a value for this header and the error responses to expect when it is missing or invalid.

Responses

401

Unauthorized

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Custom column created

422Validation error