Update variant

PATCH /v1/agents/{agentId}/branches/{branchId}/variants/{variantId}

Update variant

cURL

curl --request PATCH \
  --url https://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/variants/{variantId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "attributeValues": {
    "values": {}
  },
  "isDefault": true
}
'

import requests

url = "https://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/variants/{variantId}"

payload = {
    "name": "<string>",
    "attributeValues": { "values": {} },
    "isDefault": True
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', attributeValues: {values: {}}, isDefault: true})
};

fetch('https://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/variants/{variantId}', 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.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/variants/{variantId}",
  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([
    'name' => '<string>',
    'attributeValues' => [
        'values' => [
                
        ]
    ],
    'isDefault' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$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.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/variants/{variantId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"attributeValues\": {\n    \"values\": {}\n  },\n  \"isDefault\": true\n}")

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

	req.Header.Add("X-API-KEY", "<api-key>")
	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.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/variants/{variantId}")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"attributeValues\": {\n    \"values\": {}\n  },\n  \"isDefault\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/variants/{variantId}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"attributeValues\": {\n    \"values\": {}\n  },\n  \"isDefault\": true\n}"

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

200

{
  "id": "<string>",
  "name": "<string>",
  "isDefault": true,
  "attributeValues": {
    "values": {}
  }
}

Authorizations

X-API-KEY · string · header · required

Path Parameters

agentId · string · required

branchId · string · required

variantId · string · required

Body

application/json

name · string

Minimum string length: 1

attributeValues · object

Show child attributes

isDefault · boolean

Response

200 - application/json

Updated variant

id · string · required

name · string · required

isDefault · boolean · required

attributeValues · object · required

Show child attributes