Edita um rascunho
PUT/api/campaigns/{id}
- Auth
- Richiede un token
- 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.
Owner, admin, moderador e financeiro. Só rascunho (outro estado devolve 409). Todos os campos são opcionais; `blocks` e `audience` substituem o valor inteiro.
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
| Nome | Tipo | Descrizione |
|---|---|---|
namefacoltativo | string | max 200 |
subjectfacoltativo | string | max 300 |
preheaderfacoltativo | string | max 300 |
blocksfacoltativo | object[] | |
blocks[].typeobbligatorio | text | button | image | |
blocks[].htmlfacoltativo | string | Só em `text`. HTML rico, sanitizado como nos posts. `{{nome}}` vira o primeiro nome de cada pessoa. |
blocks[].textfacoltativo | string | Só em `button`. · max 80 |
blocks[].urlfacoltativo | string | Em `button` (destino) e `image` (endereço da imagem). Só http ou https. |
blocks[].altfacoltativo | string | Só em `image`. · max 200 |
audiencefacoltativo | object | Público: a união de todos os critérios, cada pessoa uma vez. Quem se descadastrou, teve bounce permanente ou reclamou nunca entra. |
audience.allfacoltativo | boolean | Toda a base da comunidade. |
audience.groupIdsfacoltativo | string (uuid)[] | |
audience.tagsfacoltativo | string[] | Nomes das tags. |
audience.profileIdsfacoltativo | string (uuid)[] | Pessoas escolhidas na mão. Quem se descadastrou é recusado com erro no campo `audience.profileIds`. |
Risposte
| Codice | Descrizione |
|---|---|
200 | Rascunho atualizado. |
400 | Requisição inválida — falha de validação. |
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. |
422 | Bloco inválido, pessoa que não é da comunidade ou que se descadastrou. |
500 | Erro interno do servidor. |
Esempio con curl
curl -X PUT "https://api.memberfy.net/api/campaigns/<id>" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'