Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
integrator
/
on-demand
/
cancel
Cancelando uma instância
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/on-demand/cancel \
  --header 'Client-Token: <api-key>'

Conceituação

Método utilizado para cancelar a assinatura de uma instância.
Ao cancelar uma instância, ela continuará ativa até o final do ciclo vigente, que corresponde ao último dia do mês. Após o encerramento do ciclo, a instância será desativada automaticamente. A cobrança será realizada normalmente até o término desse período.
Para utilizar os endpoints de Partner, informe o Token de Parceiro no campo Authorization, no formato: Bearer <Partner-Token>Não é necessário enviar o Client-Token nessas requisições.

Response

201

405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.