Skip to main content
POST
/
v1
/
approvals
/
workflows
Create approval workflow
curl --request POST \
  --url https://api.hyperline.co/v1/approvals/workflows \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Enterprise quote approval",
  "applicable_flows": [
    "quote_subscription"
  ],
  "is_active": true,
  "priority": 10,
  "step_execution": "sequential",
  "rules": [
    {
      "operator": "and",
      "conditions": [
        {
          "field": "total_amount",
          "operator": "gte",
          "value": 100000
        }
      ]
    }
  ],
  "steps": [
    {
      "name": "Finance approval",
      "order": 1,
      "approver_requirement": "any",
      "approver_role_ids": [
        "rol_DKL4Xcb5VSa8CQ"
      ],
      "approver_user_ids": [
        "usr_DKL4Xcb5VSa8CQ"
      ]
    }
  ],
  "description": "Requires approval for high-value subscription quotes.",
  "email_notification_enabled": true
}
'
{
  "id": "apw_DKL4Xcb5VSa8CQ",
  "name": "Enterprise quote approval",
  "description": "Requires approval for high-value subscription quotes.",
  "applicable_flows": [
    "quote_subscription"
  ],
  "is_active": true,
  "priority": 10,
  "rules": [
    {
      "id": "apr_DKL4Xcb5VSa8CQ",
      "operator": "and",
      "conditions": [
        {
          "field": "total_amount",
          "operator": "gte",
          "value": 100000
        }
      ]
    }
  ],
  "step_execution": "sequential",
  "email_notification_enabled": true,
  "steps": [
    {
      "id": "aps_DKL4Xcb5VSa8CQ",
      "name": "Finance approval",
      "order": 1,
      "approver_requirement": "any",
      "approver_role_ids": [
        "rol_DKL4Xcb5VSa8CQ"
      ],
      "approver_user_ids": [
        "usr_DKL4Xcb5VSa8CQ"
      ]
    }
  ],
  "version": 1,
  "original_workflow_id": null,
  "created_at": "2024-12-20T16:04:11Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Approval workflow creation payload.

​
name
string
required

Approval workflow name.

Minimum string length: 1
Example:

"Enterprise quote approval"

​
applicable_flows
enum<string>[]
required

Quote or subscription flows where the workflow applies.

Minimum array length: 1
Available options:
quote_subscription,
quote_subscription_update,
quote_one_off,
subscription_update
Example:
["quote_subscription"]
​
is_active
boolean
required

Whether the workflow is active.

Example:

true

​
priority
integer
required

Workflow priority. Lower values are evaluated first when multiple workflows match.

Example:

10

​
step_execution
enum<string>
required

How workflow steps execute. Sequential steps run by order; parallel steps run together.

Available options:
sequential,
parallel
Example:

"sequential"

​
rules
object[]
required

Rules that determine when the workflow applies.

Minimum array length: 1
​
steps
object[]
required

Approval steps required by the workflow.

Minimum array length: 1
​
description
string | null

Approval workflow description.

Example:

"Requires approval for high-value subscription quotes."

​
email_notification_enabled
boolean

Whether approvers receive email notifications for this workflow.

Example:

true

Response

201 - application/json
​
id
string
required

Approval workflow ID.

Example:

"apw_DKL4Xcb5VSa8CQ"

​
name
string
required

Approval workflow name.

Example:

"Enterprise quote approval"

​
description
string | null
required

Approval workflow description.

Example:

"Requires approval for high-value subscription quotes."

​
applicable_flows
enum<string>[]
required

Quote or subscription flows where the workflow applies.

Available options:
quote_subscription,
quote_subscription_update,
quote_one_off,
subscription_update
Example:
["quote_subscription"]
​
is_active
boolean
required

Whether the workflow is active.

Example:

true

​
priority
integer
required

Workflow priority. Lower values are evaluated first when multiple workflows match.

Example:

10

​
rules
object[]
required

Rules that determine when the workflow applies.

​
step_execution
enum<string>
required

How workflow steps execute. Sequential steps run by order; parallel steps run together.

Available options:
sequential,
parallel
Example:

"sequential"

​
email_notification_enabled
boolean
required

Whether approvers receive email notifications for this workflow.

Example:

true

​
steps
object[]
required

Approval steps required by the workflow.

​
version
integer
required

Workflow version number.

Example:

1

​
original_workflow_id
string | null
required

Original workflow ID when this workflow is an archived version.

Example:

null

​
created_at
string<date-time>
required

Approval workflow creation date. UTC date time string in the ISO 8601 format.

Example:

"2024-12-20T16:04:11Z"