Flow

Update a flow

Changed on

Updates the details of an existing flow and returns the updated information.

put/flows/{id}

Request

  • Base URL
    https://api.voipbin.net/v1.0
  • URL
    https://api.voipbin.net/v1.0/flows/{id}
  • Auth
    none declared

Path parameters

idstring required

The ID of the flow.

Request body

namestring

The updated name of the flow. Omit to leave unchanged.

detailstring

The updated details of the flow. Omit to leave unchanged.

on_complete_flow_idstring

ID of the flow to be executed on completion. Omit to leave unchanged.

Example request

{
  "actions": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "next_id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "talk",
      "tm_execute": "2026-01-15T09:30:00.000000Z"
    }
  ]
}

Response

The updated flow details.

idstring uuid

Unique identifier for the flow.

customer_idstring uuid

The unique identifier of the customer who owns this flow. Returned from the GET /customers response.

type'flow' | 'conference' | 'queue' | 'campaign' | 'transfer'

Type of the flow.

namestring

Name of the flow.

detailstring

Detailed description of the flow.

direct_hashstring

The direct hash for direct access via SIP URI sip:<direct_hash>@sip.voipbin.net (the "direct." prefix is already included in the value, e.g. "direct.a1b2c3d4e5f6"). Returned from the resource's direct_hash field.

on_complete_flow_idstring uuid

The unique identifier of the flow to execute on completion. Returned from the POST /flows or GET /flows response.

tm_createstring date-time

Timestamp when the flow was created.

tm_updatestring date-time

Timestamp when the flow was last updated.

tm_deletestring date-time

Timestamp when the flow was deleted.

Example response

{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "type": "flow",
  "name": "Inbound Call Handler",
  "detail": "Main flow for handling inbound customer calls",
  "actions": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "next_id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "talk",
      "tm_execute": "2026-01-15T09:30:00.000000Z"
    }
  ],
  "direct_hash": "direct.a1b2c3d4e5f6",
  "on_complete_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-15T09:30:00.000000Z",
  "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Changes