Pular para o conteúdo principal

Editar instância

Aprenda como editar uma instância gzappy.

Enviando em Node.js​

javascript
import gzappy from "gzappy-js";

const gClient = new gzappy({
  token: process.env.GZAPPY_API_TOKEN,
  instanceId: process.env.GZAPPY_INSTANCE_ID,
});

const INSTANCE_ID = "ID DA INSTANCIA";
const WEBHOOK_URL = "https://example.com/webhook";

// Editar instancias
gClient
  .editInstance(INSTANCE_ID, "Novo nome da instância", WEBHOOK_URL)
  .then((response) => console.log(response))
  .catch((error) => console.error(error));

Enviando em cURL​

cURL
curl -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $GZAPPY_API_TOKEN" \
  -d '{
    "instance_name": "string",
    "instance_id": "string",
    "webhook_receivement_message_url"?: "string"
  }' \
  https://api.gzappy.com/v1/instances/update

  • instance_name: Nome que deseja dar para sua instância.

    • Tipo: string
    • Obrigatório: sim

  • webhook_receivement_message_url: Webhook URL para receber mensagens recebidas na instância.

    • Tipo: string
    • Obrigatório: não

  • instance_id: ID da instância que deseja editar.

    • Tipo: string
    • Obrigatório: sim

Resposta da Requisição​

Response - 200
{
  "msg": "Instance updated"
}

Editar uma instância é tão simples quanto enviar uma requisição HTTP informando o nome da instância que deseja editar, o ID da instância e o token da instância. Tendo sucesso na resposta, você irá receber uma mensagem de sucesso informando que a instância foi editada com sucesso.