Skip to main content
POST
/
workflow_executions
/
{execution_id}
/
resume
Resume waiting workflow execution
curl --request POST \
  --url https://api.kapso.ai/platform/v1/workflow_executions/{execution_id}/resume \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "message": {
    "data": "yes, proceed",
    "kind": "payload"
  },
  "variables": {
    "estado": "retomado",
    "custom_var": 123,
    "user_response": "confirmed"
  }
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "running",
    "started_at": "2023-11-07T05:31:56Z",
    "last_event_at": "2023-11-07T05:31:56Z",
    "ended_at": "2023-11-07T05:31:56Z",
    "tracking_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "whatsapp_conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "status": "<string>"
    },
    "current_step": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "identifier": "<string>",
      "stepable_type": "<string>",
      "position": {
        "x": 123,
        "y": 123
      }
    },
    "error_details": {}
  }
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
execution_id
string<uuid>
required

Execution identifier

Body

application/json

Request to resume a workflow execution that is in 'waiting' status. Executions wait when they reach a wait_for_response step or when explicitly paused. The message data can be a simple string for text responses or a structured object for complex interactions.

You can optionally include variables to update the execution context with new or modified variables that will be available to subsequent workflow steps.

​
message
object
required
​
variables
object

Optional variables to merge into the execution context. These variables will be added to the vars section of the execution context, making them available throughout the workflow. New variables are merged with existing ones - duplicate keys will be overwritten with new values.

Example:
{
  "estado": "retomado",
  "custom_var": 123,
  "user_response": "confirmed"
}

Response

Execution resumed successfully

Minimal workflow execution response (without execution_context and events)

​
data
object
required

Base workflow execution schema