Create Approval Request

post

https://api.approveit.today/api/v1/approval-requests

Creates a new approval request via the API.

Required Fields:

workflow_slug: The slug of the workflow to use
data: Dictionary containing the approval request field values

Optional Fields:

process_id: Associate with an existing process
priority: Set priority level (low, medium, high, critical)
requestor_email: Email of the requestor (must be a team member)
approvers: List of approvers for the request
completion_type: List of completion type objects specifying approval requirements per step

The approval request will be automatically approved if no approvers are required.

Example Request:

{
  "workflow_slug": "TOAF-20",
  "data": {
    "21f90049-3070-4c96-a306-d8a0e10c0a0e": {
      "id": "21f90049-3070-4c96-a306-d8a0e10c0a0e",
      "label": "Employee",
      "value": "69470"
    },
    "b7f090b4-e738-4d05-98ff-f83ba6a6fa3f": {
      "id": "b7f090b4-e738-4d05-98ff-f83ba6a6fa3f",
      "label": "Absence From",
      "value": "2025-11-10T09:28:03.767Z"
    },
    "48fd294a-12e5-42ad-b545-3fb64e63af59": {
      "id": "48fd294a-12e5-42ad-b545-3fb64e63af59",
      "label": "Absence To",
      "value": "2025-11-10T09:28:03.767Z"
    }
  },
  "approvers": [{"email": "[email protected]", "step_order": 0}],
  "completion_type": [{"type": "any", "step_order": 0}]
}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

workflow_slug

string

required

Slug of the workflow associated with the approval request. This identifies which workflow template to use.

process_id

integer

ID of an existing process to associate with this approval request. If not provided, a new process will be created.

priority

string

enum

Priority level of the approval request. Options: low, medium, high, critical. Defaults to medium.

Allowed:

requestor_email

string

Email address of the approval request initiator. Must belong to a user in the team. If not provided, the API key owner will be used.

data

object

required

Approval request data fields. This is a dictionary where each key is a field UUID, and each value is an object containing id, label, and value properties. The field UUIDs and structure are defined by the workflow's form configuration.

Example:

{
  "21f90049-3070-4c96-a306-d8a0e10c0a0e": {
    "id": "21f90049-3070-4c96-a306-d8a0e10c0a0e",
    "label": "Employee",
    "value": "69470"
  },
  "b7f090b4-e738-4d05-98ff-f83ba6a6fa3f": {
    "id": "b7f090b4-e738-4d05-98ff-f83ba6a6fa3f",
    "label": "Absence From",
    "value": "2025-11-10T09:28:03.767Z"
  },
  "48fd294a-12e5-42ad-b545-3fb64e63af59": {
    "id": "48fd294a-12e5-42ad-b545-3fb64e63af59",
    "label": "Absence To",
    "value": "2025-11-10T09:28:03.767Z"
  }
}

approvers

array of objects

List of approvers for the approval request. Each approver object should have email (string) and step_order (integer) properties. Can be empty array if no specific approvers are required.

approvers

completion_type

array of objects

List of completion type objects specifying approval requirements for each step. Each object should have type ('any' or 'all') and step_order (integer).

completion_type

Responses

201Approval request created successfully

400Validation errors