Approval policies

Update an approval policy

Update an existing approval policy.

patch/approval_policies/{approval_policy_id}

Request

  • Base URL: https://api.sandbox.monite.com/v1
  • URL: https://api.sandbox.monite.com/v1/approval_policies/{approval_policy_id}
  • Auth: HTTP bearer

Path parameters

approval_policy_idstring required

Headers

x-monite-versionstring required
x-monite-entity-idstring required

The ID of the entity that owns the requested resource.

Request body

descriptionstring

A brief description of the approval policy.

ends_atstring date-time

The date and time (in the ISO 8601 format) when the approval policy stops being active and stops triggering approval workflows.If ends_at is provided in the request, then starts_at must also be provided and ends_at must be later than starts_at. The value will be converted to UTC.

namestring

The name of the approval policy.

priorityinteger

The priority controls which approval policy takes precedence when a payable matches multiple approval policies. A higher value mean higher priority.

starts_atstring date-time

The date and time (in the ISO 8601 format) when the approval policy becomes active. Only payables submitted for approval during the policy's active period will trigger this policy. If omitted or null, the policy is effective immediately. The value will be converted to UTC.

status'active' | 'deleted' | 'pending'

Response

Successful Response

idstring uuid required
created_atstring date-time required
updated_atstring date-time required
created_bystring uuid required
descriptionstring

A brief description of the approval policy.

ends_atstring date-time

The date and time (in the ISO 8601 format) when the approval policy stops being active and stops triggering approval workflows.If ends_at is provided in the request, then starts_at must also be provided and ends_at must be later than starts_at. The value will be converted to UTC.

namestring required

The name of the approval policy.

priorityinteger

The priority controls which approval policy takes precedence when a payable matches multiple approval policies. A higher value mean higher priority.

starts_atstring date-time

The date and time (in the ISO 8601 format) when the approval policy becomes active. Only payables submitted for approval during the policy's active period will trigger this policy. If omitted or null, the policy is effective immediately. The value will be converted to UTC.

status'active' | 'pending' required

The current status of the approval policy.

updated_bystring uuid

Changes

No recorded changes to this operation across all 1 revision of this API.