Skip to main content
PUT
/
campaigns
/
{campaignId}
/
vocabulary
Update existing vocabulary entries
curl --request PUT \
  --url https://api.callers.ai/campaigns/{campaignId}/vocabulary \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "vocabulary": [
    {
      "content": "<string>",
      "sounds_like": [
        "<string>"
      ]
    }
  ]
}
'
import requests

url = "https://api.callers.ai/campaigns/{campaignId}/vocabulary"

payload = { "vocabulary": [
{
"content": "<string>",
"sounds_like": ["<string>"]
}
] }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({vocabulary: [{content: '<string>', sounds_like: ['<string>']}]})
};

fetch('https://api.callers.ai/campaigns/{campaignId}/vocabulary', 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.callers.ai/campaigns/{campaignId}/vocabulary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'vocabulary' => [
[
'content' => '<string>',
'sounds_like' => [
'<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.callers.ai/campaigns/{campaignId}/vocabulary"

payload := strings.NewReader("{\n \"vocabulary\": [\n {\n \"content\": \"<string>\",\n \"sounds_like\": [\n \"<string>\"\n ]\n }\n ]\n}")

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

req.Header.Add("Authorization", "<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.put("https://api.callers.ai/campaigns/{campaignId}/vocabulary")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"vocabulary\": [\n {\n \"content\": \"<string>\",\n \"sounds_like\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.callers.ai/campaigns/{campaignId}/vocabulary")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"vocabulary\": [\n {\n \"content\": \"<string>\",\n \"sounds_like\": [\n \"<string>\"\n ]\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "updatedCount": 123
}
{
"status": "error",
"message": "<string>",
"data": [
{}
]
}
{
"status": "error",
"message": "<string>"
}

Authorizations

Authorization
string
header
required

Headers

x-sub-organization-id
string

Optional sub organization ID. Must belong to your main organization API key.

Path Parameters

campaignId
string
required

ID of the campaign

Body

application/json
vocabulary
object[]
required
Required array length: 1 - 1000 elements

Response

Existing vocabulary entries updated

success
boolean
updatedCount
number