campaigns
PATCH /v1/campaigns/segments/{segmentId}
Rename a segment or change its filters.
Autenticação
Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.
Onde vai o ID da sua organização
Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.
O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X PATCH https://api.zinndigital.com/v1/campaigns/segments/{segmentId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string>, "definition": <CampaignSegmentNode> }'Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
`scope` is absent from the body and cannot be changed: a segment reviewed and approved as "my clients" must not silently become "the estate".
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
segmentId (path) | string | Sim | — |
org_id (query) | string | Não | — |
Corpo da requisição
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
name | string | Sim | — |
description | string | Não | — |
definition | CampaignSegmentNode | Sim | A filter tree. Two node shapes and no third: a GROUP (`op` with `children`) or a CONDITION (`field`/`operator`/`value`). `not` takes exactly one child — an n-ary `not` reads as… |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
id | string | Sim | — |
org_id | string | Sim | The segment's OWNER, not the orgs it selects. |
scope | string<platform, reseller> | Sim | — |
name | string | Sim | — |
description | string | Não | — |
definition | CampaignSegmentNode | Sim | A filter tree. Two node shapes and no third: a GROUP (`op` with `children`) or a CONDITION (`field`/`operator`/`value`). `not` takes exactly one child — an n-ary `not` reads as… |
status | string<active, archived> | Sim | — |
created_by | string | Não | — |
created_at | string | Não | — |
updated_at | string | Não | — |
Erros que este endpoint pode retornar
401 · 403 · 404 · 422