Update a competitor
curl --request PUT \
--url https://api.beeze.io/v1/ai-search/competitors/{competitorId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"competitorName": "<string>",
"displayName": "<string>",
"competitorDomain": "<string>",
"project": "<string>",
"color": "<string>"
}
'import requests
url = "https://api.beeze.io/v1/ai-search/competitors/{competitorId}"
payload = {
"competitorName": "<string>",
"displayName": "<string>",
"competitorDomain": "<string>",
"project": "<string>",
"color": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
competitorName: '<string>',
displayName: '<string>',
competitorDomain: '<string>',
project: '<string>',
color: '<string>'
})
};
fetch('https://api.beeze.io/v1/ai-search/competitors/{competitorId}', 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.beeze.io/v1/ai-search/competitors/{competitorId}",
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([
'competitorName' => '<string>',
'displayName' => '<string>',
'competitorDomain' => '<string>',
'project' => '<string>',
'color' => '<string>'
]),
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.beeze.io/v1/ai-search/competitors/{competitorId}"
payload := strings.NewReader("{\n \"competitorName\": \"<string>\",\n \"displayName\": \"<string>\",\n \"competitorDomain\": \"<string>\",\n \"project\": \"<string>\",\n \"color\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.beeze.io/v1/ai-search/competitors/{competitorId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"competitorName\": \"<string>\",\n \"displayName\": \"<string>\",\n \"competitorDomain\": \"<string>\",\n \"project\": \"<string>\",\n \"color\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beeze.io/v1/ai-search/competitors/{competitorId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"competitorName\": \"<string>\",\n \"displayName\": \"<string>\",\n \"competitorDomain\": \"<string>\",\n \"project\": \"<string>\",\n \"color\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"isSuggested": true,
"createdAt": "<string>",
"updatedAt": "<string>",
"competitorName": "<string>",
"displayName": "<string>",
"competitorDomain": "<string>",
"project": "<string>",
"mentionCount": 123,
"color": "<string>"
}
}{
"status": 123,
"detail": "<string>",
"code": "<string>",
"type": "<string>",
"title": "<string>",
"requestId": "<string>",
"instance": "<string>"
}{
"status": 123,
"detail": "<string>",
"code": "<string>",
"type": "<string>",
"title": "<string>",
"requestId": "<string>",
"instance": "<string>"
}{
"status": 123,
"detail": "<string>",
"code": "<string>",
"type": "<string>",
"title": "<string>",
"requestId": "<string>",
"instance": "<string>"
}{
"status": 123,
"detail": "<string>",
"code": "<string>",
"type": "<string>",
"title": "<string>",
"requestId": "<string>",
"instance": "<string>"
}AI Search
Update a competitor
PUT
/
ai-search
/
competitors
/
{competitorId}
Update a competitor
curl --request PUT \
--url https://api.beeze.io/v1/ai-search/competitors/{competitorId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"competitorName": "<string>",
"displayName": "<string>",
"competitorDomain": "<string>",
"project": "<string>",
"color": "<string>"
}
'import requests
url = "https://api.beeze.io/v1/ai-search/competitors/{competitorId}"
payload = {
"competitorName": "<string>",
"displayName": "<string>",
"competitorDomain": "<string>",
"project": "<string>",
"color": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
competitorName: '<string>',
displayName: '<string>',
competitorDomain: '<string>',
project: '<string>',
color: '<string>'
})
};
fetch('https://api.beeze.io/v1/ai-search/competitors/{competitorId}', 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.beeze.io/v1/ai-search/competitors/{competitorId}",
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([
'competitorName' => '<string>',
'displayName' => '<string>',
'competitorDomain' => '<string>',
'project' => '<string>',
'color' => '<string>'
]),
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.beeze.io/v1/ai-search/competitors/{competitorId}"
payload := strings.NewReader("{\n \"competitorName\": \"<string>\",\n \"displayName\": \"<string>\",\n \"competitorDomain\": \"<string>\",\n \"project\": \"<string>\",\n \"color\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.beeze.io/v1/ai-search/competitors/{competitorId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"competitorName\": \"<string>\",\n \"displayName\": \"<string>\",\n \"competitorDomain\": \"<string>\",\n \"project\": \"<string>\",\n \"color\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beeze.io/v1/ai-search/competitors/{competitorId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"competitorName\": \"<string>\",\n \"displayName\": \"<string>\",\n \"competitorDomain\": \"<string>\",\n \"project\": \"<string>\",\n \"color\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"isSuggested": true,
"createdAt": "<string>",
"updatedAt": "<string>",
"competitorName": "<string>",
"displayName": "<string>",
"competitorDomain": "<string>",
"project": "<string>",
"mentionCount": 123,
"color": "<string>"
}
}{
"status": 123,
"detail": "<string>",
"code": "<string>",
"type": "<string>",
"title": "<string>",
"requestId": "<string>",
"instance": "<string>"
}{
"status": 123,
"detail": "<string>",
"code": "<string>",
"type": "<string>",
"title": "<string>",
"requestId": "<string>",
"instance": "<string>"
}{
"status": 123,
"detail": "<string>",
"code": "<string>",
"type": "<string>",
"title": "<string>",
"requestId": "<string>",
"instance": "<string>"
}{
"status": 123,
"detail": "<string>",
"code": "<string>",
"type": "<string>",
"title": "<string>",
"requestId": "<string>",
"instance": "<string>"
}Authorizations
API key for external Beeze API access
Path Parameters
Body
application/json
Response
Competitor updated
Show child attributes
Show child attributes
⌘I