Cancelar disparo

POST/broadcasts/{broadcast_id}/cancel

Gerada do contrato OpenAPI

Para um Broadcast que ainda não saiu, como o Cancelar do menu da lista. Na tela, o Cancelar só aparece enquanto o Broadcast está Agendado, Pendente ou no começo do envio; depois disso, não dá mais para parar. Cancelado, o estado vira CANCELLED. Veja Reenviar, cancelar e exportar um Broadcast.

Requisição

curl -X POST "https://app.nextagsai.com.br/api/broadcasts/7001/cancel" \
  -H "X-ACCESS-TOKEN: $NEXTAGS_API_KEY"

const resposta = await fetch('https://app.nextagsai.com.br/api/broadcasts/7001/cancel', {
  method: 'POST',
  headers: {
    'X-ACCESS-TOKEN': process.env.NEXTAGS_API_KEY,
  },
});
const dados = await resposta.json();
console.log(resposta.status, dados);

import os

import requests

resposta = requests.post(
    "https://app.nextagsai.com.br/api/broadcasts/7001/cancel",
    headers={"X-ACCESS-TOKEN": os.environ["NEXTAGS_API_KEY"]},
    timeout=30,
)
print(resposta.status_code, resposta.json())

<?php
$ch = curl_init('https://app.nextagsai.com.br/api/broadcasts/7001/cancel');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'X-ACCESS-TOKEN: ' . getenv('NEXTAGS_API_KEY'),
    ],
]);
$dados = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($dados);

Autenticação

Mande a chave de API da conta no cabeçalho X-ACCESS-TOKEN de cada chamada. Veja Autenticação com a chave de API.

Parâmetros de caminho

broadcast_idintegerobrigatório

O ID do Broadcast (veja Listar disparos).

Respostas

200Sucesso

O Broadcast foi cancelado.

successboolean

true quando deu certo.

401Chave inválida

A chave de API não veio no cabeçalho ou não vale (foi excluída ou está incompleta). Veja Autenticação.

Relacionados

Este conteúdo ajudou?

Obrigado! Sua resposta ajuda a melhorar a central.

const resposta = await fetch('https://app.nextagsai.com.br/api/broadcasts/7001/cancel', { method: 'POST', headers: { 'X-ACCESS-TOKEN': process.env.NEXTAGS_API_KEY, }, }); const dados = await resposta.json(); console.log(resposta.status, dados);

import os import requests resposta = requests.post( "https://app.nextagsai.com.br/api/broadcasts/7001/cancel", headers={"X-ACCESS-TOKEN": os.environ["NEXTAGS_API_KEY"]}, timeout=30, ) print(resposta.status_code, resposta.json())

<?php $ch = curl_init('https://app.nextagsai.com.br/api/broadcasts/7001/cancel'); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => [ 'X-ACCESS-TOKEN: ' . getenv('NEXTAGS_API_KEY'), ], ]); $dados = json_decode(curl_exec($ch), true); echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL; print_r($dados);

Autenticação

Parâmetros de caminho

Respostas

Relacionados

Visão geral da API

Acompanhar, reenviar e cancelar disparos

Reenviar, cancelar e exportar um Broadcast

Listar disparos

Consultar disparo

Reenviar disparo