Create Custom Field

post

https://partner-api.getpliant.com/api/transactions/custom-fields

Create a new custom field for the organization. Custom fields can be used to store additional information on transactions. For example, you can create a custom field to store an internal identifier, a project name, or accounting related data. Custom fields can be of type TEXT or SELECT. TEXT custom fields can store any text value. SELECT custom fields can store a fixed set of options. Each new custom field is created ACTIVE.

Query Params

organizationId

uuid

required

The unique identifier of the organization to create the custom field for.

Body Params

label

string

required

The label of the custom field, displayed in the UI.

description

string

The description of the custom field, displayed in the UI, optional.

defaultValue

string

The default value of the custom field, optional.

type

string

enum

required

The type of the custom field. TEXT represents a custom field which can store any text value. SELECT represents a custom field which can store a fixed set of options.

Allowed:

automationType

string

enum

required

The automation type of the custom field. For now only CARD is supported. This means, that the custom fields default value will be copied to every transaction made with the card the field is set on.

Allowed:

mandatoryOnAutomation

boolean

required

If set to true, this means this custom field is mandatory to be filled with a default value on the level of the automation, here CARD.

mandatoryForExport

boolean

required

If set to true, this means this custom field is mandatory to be filled on every transaction which should be exported with the Pliant accounting export.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

200Ok. The custom field can be used after you received the callback for the CUSTOM_FIELD_CREATED event.

400Bad Request. The API consumer sent a malformed request which could not be processed.

401Unauthorized. The API consumer is not authorized to access the requested resource.

403Forbidden. The API consumer is not allowed to access the requested resource.

429Too Many Requests. The API consumer has sent too many requests in a given amount of time. Please check our API guidelines.

500Internal Server Error. The request was not completed due to an internal error.