Cancela uma campanha
POST/api/campaigns/{id}/cancel
- Auth
- Exige token
- Quem pode:
- owner
- admin
- X-CommunityId
X-CommunityIdEnvie o X-CommunityId da comunidade em que a operação acontece.
**Só owner e admin.** Cancela uma campanha agendada, recorrente, pausada ou em envio: nada mais sai (o que já foi enviado fica enviado). Não tem volta; para enviar de novo, crie outra campanha. Campanha em rascunho ou já encerrada devolve 409.
Parâmetros
| Nome | Onde | Tipo | Descrição |
|---|---|---|---|
idobrigatório | path | string (uuid) |
Headers
| Nome | Tipo | Descrição |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corpo da requisição application/json
A especificação não declara os campos deste corpo (upload multipart, por exemplo). Consulte o guia do assunto.
Respostas
| Código | Descrição |
|---|---|
200 | Campanha cancelada. |
401 | Token ausente, inválido ou expirado. |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
409 | Conflito com o estado atual do recurso. |
500 | Erro interno do servidor. |
Exemplo com curl
curl -X POST "https://api.memberfy.net/api/campaigns/<id>/cancel" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'