Update the status of an Execution to `ended`

POST /v2/Flows/{FlowSid}/Executions/{Sid}

Executions of Studio flows

Update the status of an Execution to ended.

Path parameters

  • FlowSid string Required

    The SID of the Flow with the Execution resources to update.

  • Sid string Required

    The SID of the Execution resource to update.

Body

  • Status string Required

    The status of the Execution. Can only be ended.

    Values are active or ended.

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • contact_channel_address string | null

      The phone number, SIP address or Client identifier that triggered the Execution

    • context

      The current state of the flow

    • date_created string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was created

    • date_updated string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was last updated

    • flow_sid string | null

      The SID of the Flow

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^FW[0-9a-fA-F]{32}$.

    • links object(uri-map) | null

      Nested resource URLs

    • sid string | null

      The unique string that identifies the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^FN[0-9a-fA-F]{32}$.

    • status string | null

      The status of the Execution

      Values are active or ended.

    • url string(uri) | null

      The absolute URL of the resource
POST /v2/Flows/{FlowSid}/Executions/{Sid} 
curl \
 -X POST https://studio.twilio.com/v2/Flows/{FlowSid}/Executions/{Sid} \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Status=active'
Request example 
{
  "Status": "active"
}
Request examples 
{
  "Status": "active"
}
Response examples (200) 
{
  "account_sid": "string",
  "contact_channel_address": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "flow_sid": "string",
  "links": {},
  "sid": "string",
  "status": "active",
  "url": "https://example.com"
}
Response examples (200) 
{
  "account_sid": "string",
  "contact_channel_address": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "flow_sid": "string",
  "links": {},
  "sid": "string",
  "status": "active",
  "url": "https://example.com"
}