Pular para o conteúdo principal
POST
/
api
/
v1
/
accounts
/
{account_id}
/
portals
/
{id}
/
categories
Adicionar um novo category
curl --request POST \
  --url https://airys.chat/api/v1/accounts/{account_id}/portals/{id}/categories \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "name": "Category Name",
  "description": "Category description",
  "position": 1,
  "slug": "category-name",
  "locale": "en",
  "icon": "📚",
  "parent_category_id": 1,
  "associated_category_id": 2
}
'
import requests

url = "https://airys.chat/api/v1/accounts/{account_id}/portals/{id}/categories"

payload = {
"name": "Category Name",
"description": "Category description",
"position": 1,
"slug": "category-name",
"locale": "en",
"icon": "📚",
"parent_category_id": 1,
"associated_category_id": 2
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Category Name',
description: 'Category description',
position: 1,
slug: 'category-name',
locale: 'en',
icon: '📚',
parent_category_id: 1,
associated_category_id: 2
})
};

fetch('https://airys.chat/api/v1/accounts/{account_id}/portals/{id}/categories', 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://airys.chat/api/v1/accounts/{account_id}/portals/{id}/categories",
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([
'name' => 'Category Name',
'description' => 'Category description',
'position' => 1,
'slug' => 'category-name',
'locale' => 'en',
'icon' => '📚',
'parent_category_id' => 1,
'associated_category_id' => 2
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_access_token: <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://airys.chat/api/v1/accounts/{account_id}/portals/{id}/categories"

payload := strings.NewReader("{\n \"name\": \"Category Name\",\n \"description\": \"Category description\",\n \"position\": 1,\n \"slug\": \"category-name\",\n \"locale\": \"en\",\n \"icon\": \"📚\",\n \"parent_category_id\": 1,\n \"associated_category_id\": 2\n}")

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

req.Header.Add("api_access_token", "<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://airys.chat/api/v1/accounts/{account_id}/portals/{id}/categories")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Category Name\",\n \"description\": \"Category description\",\n \"position\": 1,\n \"slug\": \"category-name\",\n \"locale\": \"en\",\n \"icon\": \"📚\",\n \"parent_category_id\": 1,\n \"associated_category_id\": 2\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://airys.chat/api/v1/accounts/{account_id}/portals/{id}/categories")

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

request = Net::HTTP::Post.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Category Name\",\n \"description\": \"Category description\",\n \"position\": 1,\n \"slug\": \"category-name\",\n \"locale\": \"en\",\n \"icon\": \"📚\",\n \"parent_category_id\": 1,\n \"associated_category_id\": 2\n}"

response = http.request(request)
puts response.read_body
{
  "id": 123,
  "description": "<string>",
  "locale": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "position": 123,
  "portal_id": 123,
  "account_id": 123,
  "associated_category_id": 123,
  "parent_category_id": 123
}
{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}

Autorizações

api_access_token
string
header
obrigatório

Este token pode ser obtido visitando a página de perfil ou por meio do console rails. Fornece acesso a endpoints com base nos níveis de permissões do usuário. Este token pode ser salvo por um sistema externo quando o usuário é criado via API, para realizar atividades em nome do usuário.

Parâmetros de caminho

account_id
integer
obrigatório

O ID numérico da conta

id
string
obrigatório

O identificador de slug do portal

Corpo

application/json
name
string

O nome da categoria

Exemplo:

"Category Name"

description
string

Uma descrição para a categoria

Exemplo:

"Category description"

position
integer

Posição da categoria na lista do portal para ordenar

Exemplo:

1

slug
string

O slug da categoria usado no URL

Exemplo:

"category-name"

locale
string

A localidade da categoria

Exemplo:

"en"

icon
string

O ícone da categoria como uma string (emoji)

Exemplo:

"📚"

parent_category_id
integer

Para definir a categoria pai, por exemplo, a documentação do produto possui recursos de vários níveis na categoria de vendas ou na categoria de engenharia.

Exemplo:

1

associated_category_id
integer

Para associar categorias semelhantes entre si, por exemplo, mesma categoria de documentação de produto em idiomas diferentes

Exemplo:

2

Resposta

Sucesso

id
integer
description
string

O conteúdo do texto.

locale
string
name
string
slug
string
position
integer
portal_id
integer
account_id
integer
associated_category_id
integer

Para associar categorias semelhantes entre si, por exemplo, mesma categoria de documentação de produto em idiomas diferentes

parent_category_id
integer

Para definir a categoria pai, por exemplo, a documentação do produto possui recursos de vários níveis na categoria de vendas ou na categoria de engenharia.