Skip to main content
POST
Update the Approvals Workflow settings
Update the Approvals Workflow settings for a specific client. This can include enabling/disabling the workflow and turning the “creator as approver” option on or off. Only the settings provided in the request will be updated; other settings are ignored.

Authorizations

x-api-key
string
header
required

An API Key.

Headers

Authorization
string
required

The access token

X-Contact-ID
string

The ID of the contact

Query Parameters

client_id
string
required

The ID of the client

Body

application/json

Client Approvals Workflow settings to be set

The Approvals Workflow settings for a client.

payment_approvals_enabled
boolean
required

Whether the Approvals Workflow is enabled for payments.

payment_creator_approval_enabled
boolean
required

Whether the creator of a payment can act as an approver.

Response

Updated client Approvals Workflow settings

The Approvals Workflow settings for a client.

payment_approvals_enabled
boolean
required

Whether the Approvals Workflow is enabled for payments.

payment_creator_approval_enabled
boolean
required

Whether the creator of a payment can act as an approver.