Atualiza as configuracoes da instancia

Server URLloading...

PATCH

/v1/instances/{id}/settings

Send

Authorization

Body

Atualiza as configuracoes de comportamento da instancia — pequenos liga/desliga aplicados ao numero conectado: rejeitar chamadas automaticamente (e responder quem ligou), ignorar mensagens de grupo, aparecer sempre online e marcar mensagens recebidas como lidas automaticamente.

E um PATCH PARCIAL: envie apenas os campos que quer alterar; os campos omitidos permanecem com o valor atual (nao sao zerados). Todos sao opcionais e o padrao de cada um e desligado (false / texto vazio), ou seja, o comportamento neutro do WhatsApp.

As configuracoes sao persistidas e aplicadas ao socket do WhatsApp em ate alguns segundos (no proximo ciclo de reconciliacao do worker) e continuam valendo apos quedas, reconexoes e deploys, sem precisar reenviar. Retorna a instancia completa, ja com o objeto "settings" atualizado.

Path Parameters

Response Body

curl -X PATCH "https://example.com/v1/instances/cm5x8a9k20001abc123def456/settings" \  -H "Content-Type: application/json" \  -d '{    "rejectCalls": true,    "rejectCallMessage": "No momento nao atendemos chamadas. Envie uma mensagem que respondemos por aqui.",    "ignoreGroups": true,    "alwaysOnline": false,    "readReceipts": true  }'

{
  "id": "string",
  "projectId": "string",
  "name": "string",
  "status": "DISCONNECTED",
  "phoneNumber": "string",
  "jid": "string",
  "settings": {
    "rejectCalls": false,
    "rejectCallMessage": "string",
    "ignoreGroups": false,
    "alwaysOnline": false,
    "readReceipts": false,
    "importHistory": false
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Body invalido"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key ausente ou invalida"
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "Projeto inativo ou sem permissao"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Instancia nao encontrada"
  }
}