Skip to main content
POST
/
categories
/
update
Update Categories
curl --request POST \
  --url https://api.peec.ai/customer/v1/categories/update \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "categories": [
    {
      "category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb"
}
'
import requests

url = "https://api.peec.ai/customer/v1/categories/update"

payload = {
    "categories": [
        {
            "category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
    ],
    "project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    categories: [
      {
        category_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        name: '<string>',
        parent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
      }
    ],
    project_id: 'or_f45b94ba-5e35-4982-93ed-285e72ee14eb'
  })
};

fetch('https://api.peec.ai/customer/v1/categories/update', 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.peec.ai/customer/v1/categories/update",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'categories' => [
        [
                'category_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'name' => '<string>',
                'parent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
        ]
    ],
    'project_id' => 'or_f45b94ba-5e35-4982-93ed-285e72ee14eb'
  ]),
  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.peec.ai/customer/v1/categories/update"

	payload := strings.NewReader("{\n  \"categories\": [\n    {\n      \"category_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"name\": \"<string>\",\n      \"parent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.peec.ai/customer/v1/categories/update")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"categories\": [\n    {\n      \"category_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"name\": \"<string>\",\n      \"parent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.peec.ai/customer/v1/categories/update")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"categories\": [\n    {\n      \"category_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"name\": \"<string>\",\n      \"parent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\n}"

response = http.request(request)
puts response.read_body
{
  "updated": [
    {
      "category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "rejected": [
    {
      "category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "message": "<string>"
    }
  ]
}

Authorizations

X-API-Key
string
header
required

Body

categories
object[]
required
Required array length: 1 - 1000 elements
project_id
string

Required if using a company api key

Example:

"or_f45b94ba-5e35-4982-93ed-285e72ee14eb"

Response

200 - application/json

Per-item update results

Per-item update results

updated
object[]
required
rejected
object[]
required