Cancela uma campanha
POST/api/campaigns/{id}/cancel
- Auth
- Requires a token
- Who can call it:
- owner
- admin
- X-CommunityId
X-CommunityIdSend the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.
**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.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string (uuid) |
Headers
| Name | Type | Description |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Request body application/json
The specification does not declare the fields of this body (a multipart upload, for example). See the topic guide.
Responses
| Status | Description |
|---|---|
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. |
curl example
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 '{}'