DOCS

PATCH/messenger/meta/phone/{_id}

WhatsApp - Atualização de campos do registro.

Método e URL

PATCH https://api.agilize.app/messenger/meta/phone/{_id}

Autenticação

Envie a chave de API no cabeçalho da requisição.

Accept: application/json
x-api-key: SUA_CHAVE_API

Parâmetros

NomeOrigemObrigatórioTipoDescrição
x-api-keyheaderSimstringChave da API de integração gerada em seu painel gerencial.
_idpathSimintegerID of WhatsApp to update
content-typeheaderSimstringapplication/json

Corpo da requisição

  • Obrigatório: Sim
  • Content-Type: application/json

Campos do corpo

CampoTipoObrigatórioValores / ExemploDescrição
phonestringNão
phoneNumberIdstringSim
statusstringNão
businessstringSim
flowstringNão
usersstringNão
metaobjectNão
isRegisteredbooleanNão
integrationTypestringNão
sendAgentNamebooleanNão
namestringNão
departmentstringNão
isToGenCasebooleanNão
lastDailyDtstring (date-time)Não
currDailySendnumberNão
maxDailySendnumberNão
registerLastAttemptAtstring (date-time)Não
registerLastErrorobjectNão
deletedbooleanNão

Estruturas internas

registerLastError

{
  "message": "string",
  "code": "number"
}

Exemplo básico:

{
  "phoneNumberId": "valor",
  "business": "valor"
}

Respostas

StatusDescriçãoConteúdo
200successapplication/json
401not authenticated
404not found
500general error

Exemplos básicos

Escolha uma linguagem para abrir o exemplo de requisição.

Testar requisição

Preencha os parâmetros, informe a chave no cabeçalho x-api-key e envie a requisição diretamente pelo navegador.

Carregando teste interativo do endpoint...