Update an API

curl --request PATCH \
  --url https://api.telnyx.com/v2/agent_gateways/{instance_id}/apis/{api_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tools": [
    "findpetsbystatus",
    "getpetbyid"
  ]
}
'

import requests

url = "https://api.telnyx.com/v2/agent_gateways/{instance_id}/apis/{api_id}"

payload = { "tools": ["findpetsbystatus", "getpetbyid"] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({tools: ['findpetsbystatus', 'getpetbyid']})
};

fetch('https://api.telnyx.com/v2/agent_gateways/{instance_id}/apis/{api_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.telnyx.com/v2/agent_gateways/{instance_id}/apis/{api_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'tools' => [
        'findpetsbystatus',
        'getpetbyid'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.telnyx.com/v2/agent_gateways/{instance_id}/apis/{api_id}"

	payload := strings.NewReader("{\n  \"tools\": [\n    \"findpetsbystatus\",\n    \"getpetbyid\"\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.telnyx.com/v2/agent_gateways/{instance_id}/apis/{api_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tools\": [\n    \"findpetsbystatus\",\n    \"getpetbyid\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.telnyx.com/v2/agent_gateways/{instance_id}/apis/{api_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tools\": [\n    \"findpetsbystatus\",\n    \"getpetbyid\"\n  ]\n}"

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

{
  "data": {
    "id": "dbe53cc0-bf7e-4f7a-8d84-752d19890eb3",
    "name": "petstore",
    "spec_url": "https://petstore3.swagger.io/api/v3/openapi.json",
    "base_url": "https://petstore3.swagger.io/api/v3",
    "auth": {
      "type": "none"
    },
    "tools": [
      "findpetsbystatus",
      "getpetbyid"
    ],
    "static_headers": {},
    "forwarded_headers": [],
    "open_to_every_key": true,
    "created_at": "2026-10-28T17:07:27.083000Z",
    "updated_at": "2026-10-28T17:07:27.083000Z"
  }
}

{
  "errors": [
    {
      "code": "10012",
      "title": "Duplicate resource",
      "detail": "Resource is a duplicate.",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10012"
      },
      "source": {
        "pointer": "/name"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10009",
      "title": "Authentication failed",
      "detail": "The required authentication headers were either invalid or not included in the request.",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10009"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "title": "Resource not found",
      "detail": "The requested resource or URL could not be found.",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10005"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "99901",
      "title": "Instance not ready",
      "detail": "The instance is not ready; its engine is not running."
    }
  ]
}

{
  "errors": [
    {
      "code": "10027",
      "title": "Unprocessable Entity",
      "detail": "The value is invalid.",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10027"
      },
      "source": {
        "pointer": "/spec_url"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "99903",
      "title": "Engine unavailable",
      "detail": "The instance's engine did not answer; try again shortly."
    }
  ]
}