Cancela uma campanha
POST/api/campaigns/{id}/cancel
- Auth
- Richiede un token
- Chi può:
- owner
- admin
- X-CommunityId
X-CommunityIdInvia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.
**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.
Parametri
| Nome | Dove | Tipo | Descrizione |
|---|---|---|---|
idobbligatorio | path | string (uuid) |
Header
| Nome | Tipo | Descrizione |
|---|---|---|
X-CommunityIdfacoltativo | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corpo della richiesta application/json
La specifica non dichiara i campi di questo corpo (un upload multipart, per esempio). Consulta la guida dell’argomento.
Risposte
| Codice | Descrizione |
|---|---|
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. |
Esempio con 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 '{}'