Update agent branch

curl -X PATCH https://api.elevenlabs.io/v1/convai/agents/agent_id/branches/branch_id \
     -H "xi-api-key: xi-api-key" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "id": "branch_8f7a6d4c2b3e4f1a9d0c",
  "name": "Feature Update Branch",
  "agent_id": "agent_3701k3ttaq12ewp8b7qv5rfyszkz",
  "description": "Branch for implementing new conversational features",
  "created_at": 1685606400,
  "last_committed_at": 1688294400,
  "is_archived": true,
  "protection_status": "writer_perms_required",
  "access_info": {
    "is_creator": true,
    "creator_name": "John Doe",
    "creator_email": "john.doe@example.com",
    "role": "admin"
  },
  "current_live_percentage": 25,
  "parent_branch": {
    "id": "branch_4a3b2c1d0e9f8a7b6c5d",
    "name": "Main Development Branch"
  },
  "most_recent_versions": [
    {
      "id": "version_1234567890abcdef",
      "agent_id": "agent_3701k3ttaq12ewp8b7qv5rfyszkz",
      "branch_id": "branch_8f7a6d4c2b3e4f1a9d0c",
      "version_description": "Added new intent recognition module",
      "seq_no_in_branch": 5,
      "time_committed_secs": 1688294400,
      "parents": {
        "in_branch_parent_id": "version_1234567890abcdee",
        "out_of_branch_parent_id": "version_0987654321fedcba",
        "merged_into_branch_id": "branch_4a3b2c1d0e9f8a7b6c5d",
        "merged_from_branch_id": "branch_8f7a6d4c2b3e4f1a9d0c"
      },
      "access_info": {
        "is_creator": true,
        "creator_name": "John Doe",
        "creator_email": "john.doe@example.com",
        "role": "admin"
      }
    }
  ]
}

Update agent branch properties such as archiving status and protection level

Path parameters

agent_idstringRequired

The id of an agent. This is returned on agent creation.

branch_idstringRequired

Unique identifier for the branch.

Request

This endpoint expects an object.

is_archivedboolean or nullOptional

Whether the branch should be archived

protection_statusenum or nullOptional

The protection level for the branch

Allowed values:

Response

Successful Response

idstring

namestring

agent_idstring

descriptionstring

created_atinteger

last_committed_atinteger

is_archivedboolean

protection_statusenum or null

Allowed values:

access_infoobject or null

Access information for the branch

current_live_percentagedouble or nullDefaults to 0

Percentage of traffic live on the branch

parent_branchobject or null

Parent branch of the branch

most_recent_versionslist of objects or null

Most recent versions on the branch

Path parameters

Headers

Request

Response

Errors