API Reference
Changelog UpdatesAPI StatusSupport

Update Custom Field

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

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

Path Params
uuid
required

The unique identifier of the custom field to update.

Body Params
string
required

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

string

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

string

The default value of the custom field, optional.

string
enum
required

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

Allowed:
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.

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.

string
enum

Controls where the values of this custom field are visible.
ADMIN_AND_CARDHOLDER makes the values visible to both admins and cardholders.
ADMIN_ONLY makes the values visible only to admins.
NOWHERE hides the values from both admins and cardholders.
Optional; if omitted, the existing value is preserved.

Allowed:
Responses

Updated 3 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 3 months ago