Pular para o conteúdo principal
PATCH
/
api
/
v1
/
accounts
/
{account_id}
/
custom_filters
/
{custom_filter_id}
Atualizar a custom filter
curl --request PATCH \
  --url https://airys.chat/api/v1/accounts/{account_id}/custom_filters/{custom_filter_id} \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "name": "My Custom Filter",
  "type": "conversation",
  "query": {}
}
'
import requests

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

payload = {
"name": "My Custom Filter",
"type": "conversation",
"query": {}
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'My Custom Filter', type: 'conversation', query: {}})
};

fetch('https://airys.chat/api/v1/accounts/{account_id}/custom_filters/{custom_filter_id}', 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_filters/{custom_filter_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'My Custom Filter',
'type' => 'conversation',
'query' => [

]
]),
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_filters/{custom_filter_id}"

payload := strings.NewReader("{\n \"name\": \"My Custom Filter\",\n \"type\": \"conversation\",\n \"query\": {}\n}")

req, _ := http.NewRequest("PATCH", 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.patch("https://airys.chat/api/v1/accounts/{account_id}/custom_filters/{custom_filter_id}")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My Custom Filter\",\n \"type\": \"conversation\",\n \"query\": {}\n}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"My Custom Filter\",\n \"type\": \"conversation\",\n \"query\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "id": 123,
  "name": "<string>",
  "query": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
{
"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

custom_filter_id
integer
obrigatório

O ID numérico do filtro personalizado

Corpo

application/json
name
string

O nome do filtro personalizado

Exemplo:

"My Custom Filter"

type
enum<string>

A descrição sobre o filtro personalizado

Opções disponíveis:
conversation,
contact,
report
Exemplo:

"conversation"

query
object

Uma consulta que precisa ser salva como um filtro personalizado

Exemplo:
{}

Resposta

Sucesso

id
number

O ID do filtro personalizado

name
string

O nome do filtro personalizado

type
enum<string>

A descrição sobre o filtro personalizado

Opções disponíveis:
conversation,
contact,
report
query
object

Uma consulta que precisa ser salva como um filtro personalizado

created_at
string<date-time>

O horário em que o filtro personalizado foi criado

updated_at
string<date-time>

O horário em que o filtro personalizado foi atualizado