Skip to main content
POST
/
flow_executions
/
{execution_id}
/
resume
Resume a waiting flow execution
curl --request POST \
  --url https://app.kapso.ai/api/v1/flow_executions/{execution_id}/resume \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "input": "yes",
  "message": {
    "button_id": "confirm_button",
    "additional_data": {
      "timestamp": "2024-01-15T10:30:00Z"
    }
  }
}
'
{
  "data": {
    "id": "exec-456def",
    "flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "running",
    "started_at": "2023-11-07T05:31:56Z",
    "ended_at": "2023-11-07T05:31:56Z",
    "last_event_at": "2023-11-07T05:31:56Z",
    "tracking_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "current_step": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Send Welcome Message",
      "step_type": "message"
    },
    "execution_context": {},
    "variables": {},
    "flow": {
      "id": "flow-123abc",
      "name": "Customer Onboarding Flow",
      "description": "Automated flow for onboarding new customers",
      "status": "active",
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "created_by": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "last_executed_at": "2023-11-07T05:31:56Z",
      "execution_count": 42
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://kapso-1adbad2d.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

API key required for all endpoints

Path Parameters

​
execution_id
string<uuid>
required

Body

application/json
​
input
string

Text input to resume the flow with

Example:

"yes"

​
message
object

Structured message data to resume with

Example:
{
  "button_id": "confirm_button",
  "additional_data": { "timestamp": "2024-01-15T10:30:00Z" }
}

Response

Flow execution resumed successfully

​
data
object