[Beta] Update Template Approval Workflow

put

https://api.pandadoc.com/public/beta/templates/{template_id}/approval-workflow

Creates or replaces the Submit for approval configuration on a template.
A template has at most one configuration; this operation always writes the
full desired end-state. steps lists the stages in the approval order and
must contain at least one stage. The property name stays steps so it
matches selected_approvers.steps on Send Document. Learn more about
approval workflows.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

template_id

string

required

Unique identifier of the template.

Body Params

Full replacement of the Submit for approval configuration.

Full replacement of the Submit for approval configuration on a
template. A template has at most one configuration; this request
creates it or replaces the existing one. steps lists the stages in
the approval order and must contain at least one stage. The property
name stays steps so it matches selected_approvers.steps on Send
Document.

is_enabled

boolean

Defaults to true

Whether Submit for approval runs when a document is created from
this template. Set to false to turn it off while keeping its
stages. Defaults to true when omitted.

is_ordering_enabled

boolean

Defaults to true

Approval order. When true, the document goes to one approver
at a time. When false, every approver is requested together.
Defaults to true when omitted.

An unconfigured GET returns false. That empty state is not this
default. Set the field, or omit it, when building a create request
from that GET body.

is_editing_allowed

boolean

Defaults to false

Whether the approvers and approval groups can be edited on documents created from this template.

steps

array of objects

required

length between 1 and 50

Stages in the approval order. Each stage is one approver or one
approval group. At least 1 stage, at most 50, and at most 100
approvers across all stages. A stage with one approver counts as
one approver. A stage with an approval group counts as each
approver in that group.

An empty array is rejected. To turn Submit for approval off
without dropping its stages, set is_enabled to false.

steps*

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully created or replaced the Submit for approval configuration.

400Bad Request error

401Authentication error

403Permission error

404Not found error

429Too many requests error