POST /v1/webhooks/endpoints/{id}/pause
POST
/v1/webhooks/endpoints/{id}/pause
const url = 'https://seu-endereco-da-api/v1/webhooks/endpoints/example/pause';const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://seu-endereco-da-api/v1/webhooks/endpoints/example/pause \ --header 'Authorization: Bearer <token>'Permissão que a Chave de acesso precisa: Gerenciar canais (channels:manage).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Path Parameters
Seção intitulada “Path Parameters”id
required
string
Responses
Seção intitulada “Responses”Os eventos seguintes ficam guardados até Retomar
Media typeapplication/json
object
id
required
string
url
required
string
description
required
string
state
required
Ativo envia; pausado guarda os eventos até Retomar; desligado não guarda nada
string
pausedAt
required
Desde quando está pausado ou desligado
string format: date-time
pausedReason
required
string
consecutiveFailures
required
number
events
required
Array<string>
allChannels
required
Vale para todos os números da conta (channelIds vazio)
boolean
channelIds
required
Array<string>
filters
required
Entre listas vale E, dentro da lista vale OU
object
pipelineIds
Pipelines; vazio ou ausente é qualquer pipeline
Array<string>
stageIds
Etapas; vazio ou ausente é qualquer etapa
Array<string>
tagIds
Etiquetas do contato; vazio ou ausente é qualquer etiqueta
Array<string>
assigneeIds
Responsáveis da conversa ou do negócio; vazio ou ausente é qualquer um
Array<string>
queued
required
Avisos guardados esperando Retomar
number
createdAt
required
string format: date-time
Example
{ "state": "ativo", "pausedReason": "failures"}