Pular para o conteúdo principal
PATCH
/
public
/
api
/
v1
/
inboxes
/
{inbox_identifier}
/
contacts
/
{contact_identifier}
Atualizar a contact
curl --request PATCH \
  --url https://airys.chat/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier} \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifier": "1234567890",
  "identifier_hash": "e93275d4eba0e5679ad55f5360af00444e2a888df9b0afa3e8b691c3173725f9",
  "email": "alice@acme.inc",
  "name": "Alice",
  "phone_number": "+123456789",
  "avatar": "<string>",
  "custom_attributes": {}
}
'
import requests

url = "https://airys.chat/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}"

payload = {
    "identifier": "1234567890",
    "identifier_hash": "e93275d4eba0e5679ad55f5360af00444e2a888df9b0afa3e8b691c3173725f9",
    "email": "alice@acme.inc",
    "name": "Alice",
    "phone_number": "+123456789",
    "avatar": "<string>",
    "custom_attributes": {}
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    identifier: '1234567890',
    identifier_hash: 'e93275d4eba0e5679ad55f5360af00444e2a888df9b0afa3e8b691c3173725f9',
    email: 'alice@acme.inc',
    name: 'Alice',
    phone_number: '+123456789',
    avatar: '<string>',
    custom_attributes: {}
  })
};

fetch('https://airys.chat/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}', 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/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}",
  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([
    'identifier' => '1234567890',
    'identifier_hash' => 'e93275d4eba0e5679ad55f5360af00444e2a888df9b0afa3e8b691c3173725f9',
    'email' => 'alice@acme.inc',
    'name' => 'Alice',
    'phone_number' => '+123456789',
    'avatar' => '<string>',
    'custom_attributes' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}"

	payload := strings.NewReader("{\n  \"identifier\": \"1234567890\",\n  \"identifier_hash\": \"e93275d4eba0e5679ad55f5360af00444e2a888df9b0afa3e8b691c3173725f9\",\n  \"email\": \"alice@acme.inc\",\n  \"name\": \"Alice\",\n  \"phone_number\": \"+123456789\",\n  \"avatar\": \"<string>\",\n  \"custom_attributes\": {}\n}")

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

	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/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}")
  .header("Content-Type", "application/json")
  .body("{\n  \"identifier\": \"1234567890\",\n  \"identifier_hash\": \"e93275d4eba0e5679ad55f5360af00444e2a888df9b0afa3e8b691c3173725f9\",\n  \"email\": \"alice@acme.inc\",\n  \"name\": \"Alice\",\n  \"phone_number\": \"+123456789\",\n  \"avatar\": \"<string>\",\n  \"custom_attributes\": {}\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://airys.chat/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"identifier\": \"1234567890\",\n  \"identifier_hash\": \"e93275d4eba0e5679ad55f5360af00444e2a888df9b0afa3e8b691c3173725f9\",\n  \"email\": \"alice@acme.inc\",\n  \"name\": \"Alice\",\n  \"phone_number\": \"+123456789\",\n  \"avatar\": \"<string>\",\n  \"custom_attributes\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "id": 123,
  "name": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "identifier": "<string>",
  "blocked": true,
  "additional_attributes": {},
  "custom_attributes": {},
  "contact_type": "<string>",
  "country_code": "<string>",
  "last_activity_at": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "last_name": "<string>",
  "middle_name": "<string>",
  "location": "<string>",
  "account_id": 123,
  "company_id": 123,
  "label_list": [
    "<string>"
  ]
}
{
  "description": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

Parâmetros de caminho

​
inbox_identifier
string
obrigatório

O identificador obtido do canal API de caixa de entrada

​
contact_identifier
string
obrigatório

O id de origem do contato obtido na criação do contato

Corpo

application/json
​
identifier
string

Identificador externo do contato

Exemplo:

"1234567890"

​
identifier_hash
string

Hash de identificador preparado para autenticação HMAC

Exemplo:

"e93275d4eba0e5679ad55f5360af00444e2a888df9b0afa3e8b691c3173725f9"

​
email
string

E-mail do contato

Exemplo:

"alice@acme.inc"

​
name
string

Nome do contato

Exemplo:

"Alice"

​
phone_number
string

Número de telefone do contato

Exemplo:

"+123456789"

​
avatar
file

Envie os dados do formulário com o binário da imagem do avatar ou use a avatar_url

​
custom_attributes
object

Atributos personalizados do cliente

Exemplo:
{}

Resposta

Sucesso

Registro de contato serializado completo retornado quando a API pública renderiza um modelo de Contato diretamente.

​
id
integer

Id do contato

​
name
string | null

Nome do contato quando disponível

​
email
string | null

E-mail do contato

​
phone_number
string | null

Número de telefone do contato

​
identifier
string | null

Identificador do contato

​
blocked
boolean

Se o contato está bloqueado

​
additional_attributes
object | null

Atributos adicionais do contato, quando presentes

​
custom_attributes
object | null

Atributos personalizados do contato, quando presentes

​
contact_type
string | null

Tipo de contato do contato, quando disponível

​
country_code
string | null

Código do país do contato

​
last_activity_at
string | null

Carimbo de data/hora da última atividade do contato no formato ISO 8601

​
created_at
string | null

Carimbo de data/hora de criação do contato no formato ISO 8601

​
updated_at
string | null

Carimbo de data/hora de atualização do contato no formato ISO 8601

​
last_name
string | null

Sobrenome do contato

​
middle_name
string | null

Nome do meio do contato

​
location
string | null

Localização do contato

​
account_id
integer

Id da conta do contato

​
company_id
integer | null

Id da empresa do contato

​
label_list
string[]

Rótulos aplicados ao contato