reseller

PUT /v1/reseller/brand/menu/{item_id}

Change one link.

Todos os endpoints de reseller

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão reseller.manage; uma chave sem ela é recusada com 403, e não 404.

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 PUT https://api.zinndigital.com/v1/reseller/brand/menu/{item_id} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "label": <string>, "url": <string> }'

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

Replaces one navigation link. Requires `reseller.manage`. ⛔ Scoped to your own organisation as well as to the id. A `get(pk=…)` would let any reseller edit any other reseller's link by guessing a uuid — and uuid7 is time-ordered, so guessing is less of a barrier than it sounds.

Parâmetros

NomeTipoObrigatórioO que é
org_id (query)UuidNãoThe organization this call acts on. Optional for a caller with exactly one direct membership; **required** for anyone with more than one — which is every reseller and every agen…
item_id (path)stringSim

Corpo da requisição

NomeTipoObrigatórioO que é
labelstringSim
urlstringSim
iconstringNão
positionintegerNão
new_tabbooleanNão
visibilitystring<both, client, staff>Não

Resposta

NomeTipoObrigatórioO que é
idstringSim
labelstringSim
urlstringSim
iconstringSimA design-system icon name from `icons`, or `""` for a label-only item.
positionintegerSimSort key. Ties break on the label, so the order is total and stable.
new_tabbooleanSimRenders `target="_blank"`. The panel pairs it with `rel="noopener noreferrer"` unconditionally — that is set on **every** external item, not only the new-tab ones, because `Refe…
visibilitystring<both, client, staff>SimWho sees it. Filtered **server-side** on `GET /v1/branding`: a payload carrying a staff-only link that the app hides has already disclosed it to anybody with a network tab, whic…
externalbooleanSimWhether the link leaves the panel. Computed here so every renderer agrees.

Erros que este endpoint pode retornar

401 · 403 · 404 · 422