Update Custom Field

put

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

Update an existing custom field for the organization. Custom fields can be used to store additional information on transactions.

Path Params

customFieldId

uuid

required

The unique identifier of the custom field to update.

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.

status

string

enum

required

The status of the custom field. Only an active custom field can be used.

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

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.