PApandadoc
Approval Workflows

[Beta] Update Template Approval Workflow

Changed on

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.

put/public/beta/templates/{template_id}/approval-workflow

Request

Request body

is_enabledboolean

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_enabledboolean

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_allowedboolean

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

Example request

{
  "steps": [
    {
      "assignee": {
        "membership_id": "QMDSzwabfFzTgjW6KijHyu"
      },
      "group": {
        "name": "Finance",
        "type": "selectable",
        "assignees": [
          {
            "membership_id": "QMDSzwabfFzTgjW6KijHyu"
          }
        ]
      }
    }
  ]
}

Response

Successfully created or replaced the Submit for approval configuration.

is_enabledboolean required

Stored enabled flag. A configuration that is enabled but contains only groups with no approvers is still returned as enabled. An unconfigured template returns false.

is_ordering_enabledboolean required

Approval order. When true, the document goes to one approver at a time. When false, every approver is requested together. On an unconfigured template this is false (empty state). Creating a configuration with the field omitted defaults to true.

is_editing_allowedboolean required

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

has_conditional_approvalsboolean required

true when an approver or an approval group has conditional approvals. Those conditional approvals are not included in steps. PUT on this path is rejected until they are removed in PandaDoc.

Example response

{
  "steps": [
    {
      "id": "fq9CX7PWgpe7eao6ujEdYG",
      "assignee": {
        "id": "mGVeQe7xy9AN9eCg8VSdNm",
        "user": {
          "id": "FA5QAu8UGA3oVDQZuPL75B",
          "email": "manager@example.com",
          "first_name": "Alex",
          "last_name": "Manager",
          "avatar": "https://avatars.pandadoc-static.com/users/FA5QAu8UGA3oVDQZuPL75B/avatar.jpeg"
        },
        "is_selected": true
      },
      "group": {
        "id": "XUF5pcWnMqYAfDX7mAD9kD",
        "name": "Finance",
        "type": "selectable",
        "assignees": [
          {
            "id": "mGVeQe7xy9AN9eCg8VSdNm",
            "user": {
              "id": "FA5QAu8UGA3oVDQZuPL75B",
              "email": "manager@example.com",
              "first_name": "Alex",
              "last_name": "Manager",
              "avatar": "https://avatars.pandadoc-static.com/users/FA5QAu8UGA3oVDQZuPL75B/avatar.jpeg"
            },
            "is_selected": true
          }
        ]
      }
    }
  ]
}

Changes