Atualizar configurações da instância

curl --request PATCH \ --url https://api.wappfy.io/api/instances/{id} \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "<string>", "phone_number": "+5511999999999", "cloud_phone_number_id": "1234567890", "cloud_waba_id": "9876543210", "cloud_access_token": "<string>", "webhook_url": "https://example.com/webhook" } '

{ "id": "<string>", "user_id": "<string>", "name": "<string>", "is_active": true, "created_at": "<string>", "updated_at": "<string>", "phone_number": "<string>", "display_name": "<string>", "session_name": "<string>", "phone_number_id": "<string>", "waba_id": "<string>", "access_token": "<string>", "webhook_url": "<string>", "profile_picture_url": "<string>" }

Autorizações

Authorization

string

header

obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

string<uuid>

obrigatório

ID da instância

Corpo

application/json

name

string

Nome de exibição opcional para a instância

instance_type

enum<string>

Opções disponíveis:

waha,

cloud_api

phone_number

string

Número de telefone em formato internacional (ex: +5511999999999)

Exemplo:

"+5511999999999"

cloud_phone_number_id

string

ID do Número de Telefone da Cloud API (do Meta Business)

Exemplo:

"1234567890"

cloud_waba_id

string

ID da Conta WhatsApp Business da Cloud API

Exemplo:

"9876543210"

cloud_access_token

string

Token de acesso permanente da Cloud API do Meta

webhook_url

string

URL de webhook personalizada para esta instância

Exemplo:

"https://example.com/webhook"

Resposta

Instância atualizada

string

obrigatório

user_id

string

obrigatório

name

string

obrigatório

instance_type

enum<string>

obrigatório

Opções disponíveis:

waha,

cloud_api

status

enum<string>

obrigatório

Opções disponíveis:

created,

starting,

scan_qr,

connected,

disconnected,

failed

is_active

boolean

obrigatório

created_at

string

obrigatório

updated_at

string

obrigatório

phone_number

string

display_name

string

Nome de exibição do WhatsApp (pushName)

session_name

string

phone_number_id

string

waba_id

string

access_token

string

webhook_url

string

profile_picture_url

string