Pular para o conteúdo principal
POST
/
api
/
v1
/
accounts
/
{account_id}
/
custom_attribute_definitions
Adicionar um novo custom attribute
curl --request POST \
  --url https://airys.chat/api/v1/accounts/{account_id}/custom_attribute_definitions \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "attribute_display_name": "Custom Attribute",
  "attribute_display_type": 0,
  "attribute_description": "This is a custom attribute",
  "attribute_key": "custom_attribute",
  "attribute_values": [
    "value1",
    "value2"
  ],
  "attribute_model": 0,
  "regex_pattern": "^[a-zA-Z0-9]+$",
  "regex_cue": "Please enter a valid value"
}
'
import requests

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

payload = {
"attribute_display_name": "Custom Attribute",
"attribute_display_type": 0,
"attribute_description": "This is a custom attribute",
"attribute_key": "custom_attribute",
"attribute_values": ["value1", "value2"],
"attribute_model": 0,
"regex_pattern": "^[a-zA-Z0-9]+$",
"regex_cue": "Please enter a valid value"
}
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({
attribute_display_name: 'Custom Attribute',
attribute_display_type: 0,
attribute_description: 'This is a custom attribute',
attribute_key: 'custom_attribute',
attribute_values: ['value1', 'value2'],
attribute_model: 0,
regex_pattern: '^[a-zA-Z0-9]+$',
regex_cue: 'Please enter a valid value'
})
};

fetch('https://airys.chat/api/v1/accounts/{account_id}/custom_attribute_definitions', 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}/custom_attribute_definitions",
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([
'attribute_display_name' => 'Custom Attribute',
'attribute_display_type' => 0,
'attribute_description' => 'This is a custom attribute',
'attribute_key' => 'custom_attribute',
'attribute_values' => [
'value1',
'value2'
],
'attribute_model' => 0,
'regex_pattern' => '^[a-zA-Z0-9]+$',
'regex_cue' => 'Please enter a valid value'
]),
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}/custom_attribute_definitions"

payload := strings.NewReader("{\n \"attribute_display_name\": \"Custom Attribute\",\n \"attribute_display_type\": 0,\n \"attribute_description\": \"This is a custom attribute\",\n \"attribute_key\": \"custom_attribute\",\n \"attribute_values\": [\n \"value1\",\n \"value2\"\n ],\n \"attribute_model\": 0,\n \"regex_pattern\": \"^[a-zA-Z0-9]+$\",\n \"regex_cue\": \"Please enter a valid value\"\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}/custom_attribute_definitions")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"attribute_display_name\": \"Custom Attribute\",\n \"attribute_display_type\": 0,\n \"attribute_description\": \"This is a custom attribute\",\n \"attribute_key\": \"custom_attribute\",\n \"attribute_values\": [\n \"value1\",\n \"value2\"\n ],\n \"attribute_model\": 0,\n \"regex_pattern\": \"^[a-zA-Z0-9]+$\",\n \"regex_cue\": \"Please enter a valid value\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"attribute_display_name\": \"Custom Attribute\",\n \"attribute_display_type\": 0,\n \"attribute_description\": \"This is a custom attribute\",\n \"attribute_key\": \"custom_attribute\",\n \"attribute_values\": [\n \"value1\",\n \"value2\"\n ],\n \"attribute_model\": 0,\n \"regex_pattern\": \"^[a-zA-Z0-9]+$\",\n \"regex_cue\": \"Please enter a valid value\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": 123,
  "attribute_display_name": "<string>",
  "attribute_display_type": "<string>",
  "attribute_description": "<string>",
  "attribute_key": "<string>",
  "regex_pattern": "<string>",
  "regex_cue": "<string>",
  "attribute_values": "<string>",
  "attribute_model": "<string>",
  "default_value": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}
{
"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
attribute_display_name
string

Nome de exibição do atributo

Exemplo:

"Custom Attribute"

attribute_display_type
integer

Tipo de exibição do atributo (text- 0, number- 1, currency- 2, percent- 3, link- 4, date- 5, list- 6, checkbox- 7)

Exemplo:

0

attribute_description
string

Descrição do atributo

Exemplo:

"This is a custom attribute"

attribute_key
string

Valor de chave exclusiva do atributo

Exemplo:

"custom_attribute"

attribute_values
string[]

Valores de atributo

Exemplo:
["value1", "value2"]
attribute_model
integer

Tipo de atributo (conversation_attribute- 0, contact_attribute- 1)

Exemplo:

0

regex_pattern
string

Padrão de expressão regular (Apenas aplicável para o tipo- text). O padrão de expressão regular é usado para validar o(s) valor(es) do atributo.

Exemplo:

"^[a-zA-Z0-9]+$"

regex_cue
string

Mensagem de dica da expressão regular (Apenas aplicável para o tipo- text). A mensagem de dica é mostrada quando o padrão da expressão regular não corresponde.

Exemplo:

"Please enter a valid value"

Resposta

Sucesso

id
integer

Identificador

attribute_display_name
string

Nome de exibição do atributo

attribute_display_type
string

Tipo de exibição do atributo (text, number, currency, percent, link, date, list, checkbox)

attribute_description
string

Descrição do atributo

attribute_key
string

Valor de chave exclusiva do atributo

regex_pattern
string

Padrão de expressão regular (regex)

regex_cue
string

Dica de expressão regular (regex cue)

attribute_values
string

Valores de atributo

attribute_model
string

Tipo de atributo (conversation_attribute/contact_attribute)

default_value
string

Valor padrão do atributo

created_at
string

A data e hora em que o atributo personalizado foi criado

updated_at
string

A data e hora em que o atributo personalizado foi atualizado