Team

Update a team.

Changed on

Updates an existing team's details and returns the updated information.

put/teams/{id}

Request

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

Path parameters

idstring required

The ID of the team.

Request body

namestring

Name of the team. Omit to leave unchanged.

detailstring

Detailed description of the team. Omit to leave unchanged.

start_member_idstring uuid

The member ID that starts the conversation. Must reference one of the members in the (possibly pre-existing) members array. Omit to leave unchanged.

parameterobject

Custom key-value parameter data for the team. Supports flow variable substitution at runtime. Omit to leave unchanged.

Example request

{
  "name": "Customer Support Team",
  "detail": "Multi-agent team for handling customer inquiries",
  "start_member_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
  "members": [
    {
      "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "name": "Greeter",
      "ai_id": "550e8400-e29b-41d4-a716-446655440000",
      "transitions": [
        {
          "function_name": "transfer_to_specialist",
          "description": "Transfer to the specialist when the customer needs technical help",
          "next_member_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
        }
      ]
    }
  ],
  "parameter": {
    "language": "en-US",
    "department": "support"
  }
}

Response

Details of the updated team.

idstring uuid required

The unique identifier of the team.

customer_idstring uuid required

The unique identifier of the associated customer. Returned from the GET /customers response.

namestring required

Name of the team.

detailstring required

Detailed description of the team.

start_member_idstring uuid required

The member ID that starts the conversation. Must reference one of the members in the members array.

parameterobject

Custom key-value parameter data for the team. Supports flow variable substitution at runtime.

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.

tm_createstring date-time

Timestamp when the team was created.

tm_updatestring date-time

Timestamp when the team was last updated.

tm_deletestring date-time

Timestamp when the team was deleted.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "name": "Customer Support Team",
  "detail": "Multi-agent team for handling customer inquiries",
  "start_member_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
  "members": [
    {
      "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "name": "Greeter",
      "ai_id": "550e8400-e29b-41d4-a716-446655440000",
      "transitions": [
        {
          "function_name": "transfer_to_specialist",
          "description": "Transfer to the specialist when the customer needs technical help",
          "next_member_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
        }
      ]
    }
  ],
  "parameter": {
    "language": "en-US",
    "department": "support"
  },
  "direct_hash": "direct.a1b2c3d4e5f6",
  "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

  • 2a3a83d11c76Revision changes
    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional