Zum Inhalt springen

Edita um rascunho

PUT/api/campaigns/{id}

Auth
Token erforderlich
X-CommunityId
X-CommunityId Sende die X-CommunityId der Community, in der die Operation stattfindet.
Die Beschreibungen der Endpoints stammen aus der API-Spezifikation und sind vorerst auf Portugiesisch. Die Oberfläche drumherum ist übersetzt.

Owner, admin, moderador e financeiro. Só rascunho (outro estado devolve 409). Todos os campos são opcionais; `blocks` e `audience` substituem o valor inteiro.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring (uuid)

Header

NameTypBeschreibung
X-CommunityIdoptionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Request-Body application/json

NameTypBeschreibung
nameoptionalstringmax 200
subjectoptionalstringmax 300
preheaderoptionalstringmax 300
blocksoptionalobject[]
blocks[].typePflichttext | button | image
blocks[].htmloptionalstringSó em `text`. HTML rico, sanitizado como nos posts. `{{nome}}` vira o primeiro nome de cada pessoa.
blocks[].textoptionalstringSó em `button`. · max 80
blocks[].urloptionalstringEm `button` (destino) e `image` (endereço da imagem). Só http ou https.
blocks[].altoptionalstringSó em `image`. · max 200
audienceoptionalobjectPúblico: a união de todos os critérios, cada pessoa uma vez. Quem se descadastrou, teve bounce permanente ou reclamou nunca entra.
audience.alloptionalbooleanToda a base da comunidade.
audience.groupIdsoptionalstring (uuid)[]
audience.tagsoptionalstring[]Nomes das tags.
audience.profileIdsoptionalstring (uuid)[]Pessoas escolhidas na mão. Quem se descadastrou é recusado com erro no campo `audience.profileIds`.

Antworten

StatusBeschreibung
200Rascunho atualizado.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
409Conflito com o estado atual do recurso.
422Bloco inválido, pessoa que não é da comunidade ou que se descadastrou.
500Erro interno do servidor.

curl-Beispiel

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 '{}'