Controlar campanha de envio em massa

curl --request POST \
  --url https://api.zappfy.io/sender/edit \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "folder_id": "folder_123",
  "action": "stop"
}
'

{
  "status": "paused"
}

Mensagem em massa

Controlar campanha de envio em massa

Permite controlar campanhas de envio de mensagens em massa através de diferentes ações:

Ações Disponíveis:

🛑 stop - Pausar campanha

Pausa uma campanha ativa ou agendada
Altera o status para “paused”
Use quando quiser interromper temporariamente o envio
Mensagens já enviadas não são afetadas

▶️ continue - Continuar campanha

Retoma uma campanha pausada
Altera o status para “scheduled”
Use para continuar o envio após pausar uma campanha
Não funciona em campanhas já concluídas (“done”)

🗑️ delete - Deletar campanha

Remove completamente a campanha
Deleta apenas mensagens NÃO ENVIADAS (status “scheduled”)
Mensagens já enviadas são preservadas no histórico
Operação é executada de forma assíncrona

Status de Campanhas:

scheduled: Agendada para envio
sending: Enviando mensagens
paused: Pausada pelo usuário
done: Concluída (não pode ser alterada)
deleting: Sendo deletada (operação em andamento)

POST

sender

edit

Controlar campanha de envio em massa

curl --request POST \
  --url https://api.zappfy.io/sender/edit \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "folder_id": "folder_123",
  "action": "stop"
}
'

{
  "status": "paused"
}

Autorizações

token

string

header

obrigatório

Corpo

application/json

folder_id

string

obrigatório

Identificador único da campanha de envio

Exemplo:

"folder_123"

action

enum<string>

obrigatório

Ação a ser executada na campanha:

stop: Pausa a campanha (muda para status "paused")
continue: Retoma campanha pausada (muda para status "scheduled")
delete: Remove campanha e mensagens não enviadas (assíncrono)

Opções disponíveis:

stop,

continue,

delete

Exemplo:

"stop"

Resposta

Ação realizada com sucesso

Resposta para ação 'stop'
Resposta para ação 'continue'
Resposta para ação 'delete'

status

enum<string>

Status da campanha após pausar

Opções disponíveis:

paused

Exemplo:

"paused"

Criar envio em massa avançado Limpar mensagens enviadas