Update Workspace Auth Connection

PATCH https://api.elevenlabs.io/v1/workspace/auth-connections/ Content-Type: application/json

Update an auth connection

Reference: https://elevenlabs.io/docs/api-reference/workspace/auth-connections/update

• https://api.elevenlabs.io (Production, default)
• https://api.us.elevenlabs.io (Production US)
• https://api.eu.residency.elevenlabs.io (Production EU)
• https://api.in.residency.elevenlabs.io (Production India)
• https://api.sg.residency.elevenlabs.io (Production Singapore)

• auth_connection_id (string, required)

This endpoint expects a workspace_auth_connections_update_Request.

• workspace_auth_connections_update_Request

Successful Response

• workspace_auth_connections_update_Response_200
  • auth_type: oauth2_client_credentials (OAuth2ClientCredsResponse)
    • client_id (string, required)
    • id (string, required)
    • name (string, required)
    • provider (string, required)
    • token_url (string, required)
    • basic_auth_in_header (boolean, optional, default: false) — If True, send client credentials in Authorization header as Basic Auth instead of request body
    • custom_headers (map from string to string, optional) — Custom headers configured for OAuth2 token requests
    • extra_params (map from string to string, optional, default: )
    • scopes (list of string, optional, default: [])
    • status (enum, optional, default: active) — Single status field shared by every auth type's stored credential. OAuth values (REFRESH_FAILED, REVOKED) are written by the OAuth token-manager refresh path. CREDENTIAL_INVALID is written by the tool execution path when an upstream response matches a credential's failure_signatures entry (Bearer, Basic auth, etc.).
      • Allowed values: active, refresh_failed, revoked, credential_invalid
    • status_detail (string, optional, nullable)
    • status_updated_at (string, optional, nullable)
    • used_by (AuthConnectionDependencies, optional, nullable) — Dependencies that use an auth connection
  • auth_type: refresh_token_auth (RefreshTokenAuthResponse)
    • client_id (string, required)
    • id (string, required)
    • name (string, required)
    • provider (string, required)
    • token_url (string, required)
    • extra_params (map from string to string, optional, default: )
    • scopes (list of string, optional, default: [])
    • status (enum, optional, default: active) — Single status field shared by every auth type's stored credential. OAuth values (REFRESH_FAILED, REVOKED) are written by the OAuth token-manager refresh path. CREDENTIAL_INVALID is written by the tool execution path when an upstream response matches a credential's failure_signatures entry (Bearer, Basic auth, etc.).
      • Allowed values: active, refresh_failed, revoked, credential_invalid
    • status_detail (string, optional, nullable)
    • status_updated_at (string, optional, nullable)
    • used_by (AuthConnectionDependencies, optional, nullable) — Dependencies that use an auth connection
  • auth_type: basic_auth (BasicAuthResponse)
    • id (string, required)
    • name (string, required)
    • provider (string, required)
    • username (string, required)
    • status (enum, optional, default: active) — Single status field shared by every auth type's stored credential. OAuth values (REFRESH_FAILED, REVOKED) are written by the OAuth token-manager refresh path. CREDENTIAL_INVALID is written by the tool execution path when an upstream response matches a credential's failure_signatures entry (Bearer, Basic auth, etc.).
      • Allowed values: active, refresh_failed, revoked, credential_invalid
    • status_detail (string, optional, nullable)
    • status_updated_at (string, optional, nullable)
    • used_by (AuthConnectionDependencies, optional, nullable) — Dependencies that use an auth connection
  • auth_type: bearer_auth (BearerAuthResponse)
    • id (string, required)
    • name (string, required)
    • provider (string, required)
    • status (enum, optional, default: active) — Single status field shared by every auth type's stored credential. OAuth values (REFRESH_FAILED, REVOKED) are written by the OAuth token-manager refresh path. CREDENTIAL_INVALID is written by the tool execution path when an upstream response matches a credential's failure_signatures entry (Bearer, Basic auth, etc.).
      • Allowed values: active, refresh_failed, revoked, credential_invalid
    • status_detail (string, optional, nullable)
    • status_updated_at (string, optional, nullable)
    • used_by (AuthConnectionDependencies, optional, nullable) — Dependencies that use an auth connection
  • auth_type: oauth2_jwt (OAuth2JWTResponse)
    • audience (string, required) — JWT audience (aud claim)
    • id (string, required)
    • issuer (string, required) — JWT issuer (iss claim)
    • name (string, required)
    • provider (string, required)
    • subject (string, required) — JWT subject (sub claim)
    • token_url (string, required) — Token endpoint URL for exchanging JWT for access token
    • algorithm (enum, optional, default: HS256) — JWT signing algorithm
      • Allowed values: HS256, HS384, HS512, RS256, RS384, RS512
    • expiration_seconds (integer, optional, default: 3600) — Token expiration time in seconds
    • extra_params (map from string to string, optional) — Additional custom claims to include in the JWT
    • key_id (string, optional, nullable) — Key ID (kid) for JWT header - useful for key rotation
    • scopes (list of string, optional) — OAuth2 scopes to request when exchanging JWT for access token
    • status (enum, optional, default: active) — Single status field shared by every auth type's stored credential. OAuth values (REFRESH_FAILED, REVOKED) are written by the OAuth token-manager refresh path. CREDENTIAL_INVALID is written by the tool execution path when an upstream response matches a credential's failure_signatures entry (Bearer, Basic auth, etc.).
      • Allowed values: active, refresh_failed, revoked, credential_invalid
    • status_detail (string, optional, nullable)
    • status_updated_at (string, optional, nullable)
    • token_response_field (enum, optional, default: access_token) — Token field to extract from the token endpoint response.
      • Allowed values: access_token, id_token
    • used_by (AuthConnectionDependencies, optional, nullable) — Dependencies that use an auth connection
  • auth_type: private_key_jwt (PrivateKeyJWTResponse)
    • audience (string, required) — JWT audience (aud claim)
    • id (string, required)
    • issuer (string, required) — JWT issuer (iss claim)
    • name (string, required)
    • provider (string, required)
    • subject (string, required) — JWT subject (sub claim)
    • algorithm (enum, optional, default: HS256) — JWT signing algorithm
      • Allowed values: HS256, HS384, HS512, RS256, RS384, RS512
    • expiration_seconds (integer, optional, default: 3600) — Token expiration time in seconds
    • extra_params (map from string to string, optional) — Additional custom claims to include in the JWT
    • key_id (string, optional, nullable) — Key ID (kid) for JWT header - useful for key rotation
    • status (enum, optional, default: active) — Single status field shared by every auth type's stored credential. OAuth values (REFRESH_FAILED, REVOKED) are written by the OAuth token-manager refresh path. CREDENTIAL_INVALID is written by the tool execution path when an upstream response matches a credential's failure_signatures entry (Bearer, Basic auth, etc.).
      • Allowed values: active, refresh_failed, revoked, credential_invalid
    • status_detail (string, optional, nullable)
    • status_updated_at (string, optional, nullable)
    • used_by (AuthConnectionDependencies, optional, nullable) — Dependencies that use an auth connection
  • auth_type: mtls (MTLSAuthResponse)
    • id (string, required)
    • name (string, required)
    • provider (string, required)
    • status (enum, optional, default: active) — Single status field shared by every auth type's stored credential. OAuth values (REFRESH_FAILED, REVOKED) are written by the OAuth token-manager refresh path. CREDENTIAL_INVALID is written by the tool execution path when an upstream response matches a credential's failure_signatures entry (Bearer, Basic auth, etc.).
      • Allowed values: active, refresh_failed, revoked, credential_invalid
    • status_detail (string, optional, nullable)
    • status_updated_at (string, optional, nullable)
    • used_by (AuthConnectionDependencies, optional, nullable) — Dependencies that use an auth connection
  • auth_type: custom_header_auth (CustomHeaderAuthResponse)
    • header_name (string, required) — The name of the header to use for authentication (e.g., 'x-api-key')
    • id (string, required)
    • name (string, required)
    • provider (string, required)
    • status (enum, optional, default: active) — Single status field shared by every auth type's stored credential. OAuth values (REFRESH_FAILED, REVOKED) are written by the OAuth token-manager refresh path. CREDENTIAL_INVALID is written by the tool execution path when an upstream response matches a credential's failure_signatures entry (Bearer, Basic auth, etc.).
      • Allowed values: active, refresh_failed, revoked, credential_invalid
    • status_detail (string, optional, nullable)
    • status_updated_at (string, optional, nullable)
    • used_by (AuthConnectionDependencies, optional, nullable) — Dependencies that use an auth connection
  • auth_type: api_integration_oauth2_auth_code (ApiIntegrationOAuth2AuthCodeResponse)
    • credential_id (string, required)
    • expires_at (string, required) — ISO 8601 timestamp of when the access token expires
    • id (string, required)
    • integration_id (string, required)
    • name (string, required)
    • provider (string, required)
    • token_url (string, required)
    • scope_separator (enum, optional, default: ) — Separator for scopes
      • Allowed values: , ,
    • scopes (list of string, optional)
    • status (enum, optional, default: active) — Single status field shared by every auth type's stored credential. OAuth values (REFRESH_FAILED, REVOKED) are written by the OAuth token-manager refresh path. CREDENTIAL_INVALID is written by the tool execution path when an upstream response matches a credential's failure_signatures entry (Bearer, Basic auth, etc.).
      • Allowed values: active, refresh_failed, revoked, credential_invalid
    • status_detail (string, optional, nullable)
    • status_updated_at (string, optional, nullable)
    • used_by (AuthConnectionDependencies, optional, nullable) — Dependencies that use an auth connection
  • auth_type: api_integration_oauth2_custom_app (ApiIntegrationOAuth2CustomAppResponse)
    • client_id (string, required) — OAuth client ID (rendered from template if credential uses templated credentials, None for legacy connections)
    • credential_id (string, required)
    • expires_at (string, required) — ISO 8601 timestamp of when the access token expires
    • id (string, required)
    • integration_id (string, required)
    • name (string, required)
    • provider (string, required)
    • token_url (string, required)
    • scope_separator (enum, optional, default: ) — Separator for scopes
      • Allowed values: , ,
    • scopes (list of string, optional)
    • status (enum, optional, default: active) — Single status field shared by every auth type's stored credential. OAuth values (REFRESH_FAILED, REVOKED) are written by the OAuth token-manager refresh path. CREDENTIAL_INVALID is written by the tool execution path when an upstream response matches a credential's failure_signatures entry (Bearer, Basic auth, etc.).
      • Allowed values: active, refresh_failed, revoked, credential_invalid
    • status_detail (string, optional, nullable)
    • status_updated_at (string, optional, nullable)
    • used_by (AuthConnectionDependencies, optional, nullable) — Dependencies that use an auth connection
  • auth_type: whatsapp_auth (WhatsAppAuthResponse)
    • id (string, required)
    • name (string, required)
    • phone_number_id (string, required)
    • provider ("whatsapp", optional, default: whatsapp)
    • status (enum, optional, default: active) — Single status field shared by every auth type's stored credential. OAuth values (REFRESH_FAILED, REVOKED) are written by the OAuth token-manager refresh path. CREDENTIAL_INVALID is written by the tool execution path when an upstream response matches a credential's failure_signatures entry (Bearer, Basic auth, etc.).
      • Allowed values: active, refresh_failed, revoked, credential_invalid
    • status_detail (string, optional, nullable)
    • status_updated_at (string, optional, nullable)
    • used_by (AuthConnectionDependencies, optional, nullable) — Dependencies that use an auth connection
  • auth_type: slack_bot_auth (SlackBotAuthResponse)
    • id (string, required)
    • name (string, required)
    • provider ("Slack", optional, default: Slack)
    • status (enum, optional, default: active) — Single status field shared by every auth type's stored credential. OAuth values (REFRESH_FAILED, REVOKED) are written by the OAuth token-manager refresh path. CREDENTIAL_INVALID is written by the tool execution path when an upstream response matches a credential's failure_signatures entry (Bearer, Basic auth, etc.).
      • Allowed values: active, refresh_failed, revoked, credential_invalid
    • status_detail (string, optional, nullable)
    • status_updated_at (string, optional, nullable)
    • used_by (AuthConnectionDependencies, optional, nullable) — Dependencies that use an auth connection
  • auth_type: url_secret (UrlSecretAuthResponse)
    • id (string, required)
    • name (string, required)
    • provider (string, required)
    • status (enum, optional, default: active) — Single status field shared by every auth type's stored credential. OAuth values (REFRESH_FAILED, REVOKED) are written by the OAuth token-manager refresh path. CREDENTIAL_INVALID is written by the tool execution path when an upstream response matches a credential's failure_signatures entry (Bearer, Basic auth, etc.).
      • Allowed values: active, refresh_failed, revoked, credential_invalid
    • status_detail (string, optional, nullable)
    • status_updated_at (string, optional, nullable)
    • used_by (AuthConnectionDependencies, optional, nullable) — Dependencies that use an auth connection

Validation Error

• detail (list of ValidationError, optional)

• auth_type ("oauth2_client_credentials", optional, default: oauth2_client_credentials)
• provider (string, optional, nullable)
• client_id (string, optional, nullable)
• scopes (list of string, optional, nullable)
• extra_params (map from string to string, optional, nullable)
• basic_auth_in_header (boolean, optional, nullable)
• client_secret (string, optional, nullable)
• custom_headers (map from string to string, optional, nullable)

• auth_type ("basic_auth", optional, default: basic_auth)
• provider (string, optional, nullable)
• username (string, optional, nullable)
• password (string, optional, nullable)

• auth_type ("bearer_auth", optional, default: bearer_auth)
• provider (string, optional, nullable)
• token (string, optional, nullable)

• auth_type ("oauth2_jwt", optional, default: oauth2_jwt)
• provider (string, optional, nullable)
• algorithm (enum, optional, nullable)
  • Allowed values: HS256, HS384, HS512, RS256, RS384, RS512
• key_id (string, optional, nullable)
• issuer (string, optional, nullable)
• audience (string, optional, nullable)
• subject (string, optional, nullable)
• expiration_seconds (integer, optional, nullable)
• extra_params (map from string to string, optional, nullable)
• scopes (list of string, optional, nullable)
• token_response_field (enum, optional, nullable)
  • Allowed values: access_token, id_token
• secret_key (string, optional, nullable)

Dependencies that use an auth connection

• tools (list of AuthConnectionDependenciesToolsItems, optional, default: [])
• mcp_servers (list of AuthConnectionDependenciesMcpServersItems, optional, default: [])
• integration_connections (list of DependentIntegrationConnectionIdentifier, optional, default: [])

• loc (list of ValidationErrorLocItems, required)
• msg (string, required)
• type (string, required)

• type: available (DependentAvailableToolIdentifier)
  • access_level (enum, required)
    • Allowed values: admin, editor, commenter, viewer
  • created_at_unix_secs (integer, required)
  • id (string, required)
  • name (string, required)
• type: unknown (DependentUnknownToolIdentifier)
  • id (string, required)

• type: available (DependentAvailableMCPServerIdentifier)
  • access_level (enum, required)
    • Allowed values: admin, editor, commenter, viewer
  • created_at_unix_secs (integer, required)
  • id (string, required)
  • name (string, required)
• type: unknown (DependentUnknownMCPServerIdentifier)
  • id (string, required)

Identifier for an integration connection that depends on an auth connection

• id (string, required)
• name (string, required)

Request

{}

Response

{
  "auth_type": "oauth2_client_credentials",
  "client_id": "string",
  "id": "string",
  "name": "string",
  "provider": "string",
  "token_url": "string",
  "basic_auth_in_header": false,
  "custom_headers": {},
  "extra_params": {},
  "scopes": [
    "string"
  ],
  "status": "active",
  "status_detail": "string",
  "status_updated_at": "string",
  "used_by": {
    "tools": [
      {
        "type": "available",
        "access_level": "admin",
        "created_at_unix_secs": 1,
        "id": "string",
        "name": "string"
      }
    ],
    "mcp_servers": [
      {
        "type": "available",
        "access_level": "admin",
        "created_at_unix_secs": 1,
        "id": "string",
        "name": "string"
      }
    ],
    "integration_connections": [
      {
        "id": "string",
        "name": "string"
      }
    ]
  }
}

SDK Code

import { ElevenLabsClient } from "@elevenlabs/elevenlabs-js";

async function main() {
    const client = new ElevenLabsClient();
    await client.workspace.authConnections.update("auth_connection_id");
}
main();

from elevenlabs import ElevenLabs

client = ElevenLabs()

client.workspace.auth_connections.update(
    auth_connection_id="auth_connection_id",
)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.elevenlabs.io/v1/workspace/auth-connections/auth_connection_id"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.elevenlabs.io/v1/workspace/auth-connections/auth_connection_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.elevenlabs.io/v1/workspace/auth-connections/auth_connection_id")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.elevenlabs.io/v1/workspace/auth-connections/auth_connection_id', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/workspace/auth-connections/auth_connection_id");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/workspace/auth-connections/auth_connection_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()