Pular para o conteúdo principal
POST
/
api
/
v1
/
accounts
/
{account_id}
/
labels
Criar a label
curl --request POST \
  --url https://airys.chat/api/v1/accounts/{account_id}/labels \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "title": "support",
  "description": "Conversations that need support follow-up",
  "color": "#1f93ff",
  "show_on_sidebar": true
}
'
import requests

url = "https://airys.chat/api/v1/accounts/{account_id}/labels"

payload = {
    "title": "support",
    "description": "Conversations that need support follow-up",
    "color": "#1f93ff",
    "show_on_sidebar": True
}
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({
    title: 'support',
    description: 'Conversations that need support follow-up',
    color: '#1f93ff',
    show_on_sidebar: true
  })
};

fetch('https://airys.chat/api/v1/accounts/{account_id}/labels', 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}/labels",
  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([
    'title' => 'support',
    'description' => 'Conversations that need support follow-up',
    'color' => '#1f93ff',
    'show_on_sidebar' => true
  ]),
  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}/labels"

	payload := strings.NewReader("{\n  \"title\": \"support\",\n  \"description\": \"Conversations that need support follow-up\",\n  \"color\": \"#1f93ff\",\n  \"show_on_sidebar\": true\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}/labels")
  .header("api_access_token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"support\",\n  \"description\": \"Conversations that need support follow-up\",\n  \"color\": \"#1f93ff\",\n  \"show_on_sidebar\": true\n}")
  .asString();
require 'uri'
require 'net/http'

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

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  \"title\": \"support\",\n  \"description\": \"Conversations that need support follow-up\",\n  \"color\": \"#1f93ff\",\n  \"show_on_sidebar\": true\n}"

response = http.request(request)
puts response.read_body
{
  "id": 123,
  "title": "<string>",
  "description": "<string>",
  "color": "<string>",
  "show_on_sidebar": true
}
{
  "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

Corpo

application/json
title
string

O título do rótulo

Exemplo:

"support"

description
string

Uma breve descrição para o rótulo

Exemplo:

"Conversations that need support follow-up"

color
string

Código de cor hexadecimal para o rótulo

Exemplo:

"#1f93ff"

show_on_sidebar
boolean

Se o rótulo deve aparecer na barra lateral

Exemplo:

true

Resposta

Sucesso

id
number

O ID do rótulo

title
string

O título do rótulo

description
string

A descrição do rótulo

color
string

Código de cor hexadecimal para o rótulo

show_on_sidebar
boolean

Se o rótulo deve aparecer na barra lateral