agency-board

POST `/v1/agency/boards/{boardId}/invites`

Mint a copy-paste link to this board.

Uthibitishaji

Tuma ufunguo wa API kama tokeni ya kubeba. Sehemu hii ya mwisho haitaji ruhusa maalum katika maelezo, kwa hivyo ipe ufunguo wako kiwango cha chini kabisa kinachohitajika na uangalie jibu badala ya kukisia.

Endpoint hii haichukui kitambulisho cha shirika. Ufunguo wako tayari unalitambua shirika linalohusika, na jibu limewekewa kikomo kwa shirika hilo pekee.

Jaribu

Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.

curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/invites \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API

Maelezo

Returns a link you can paste into anything — a chat, an email you write yourself, a document. **No email is sent by us**, which is the point. A `viewer` link is read-only and needs **no Zinn® account**: whoever opens it sees exactly what the client sees, and can write nothing. Any other role seats the person on the board and therefore requires them to sign in first. ⛔ `token` appears in **this response only**. It cannot be read back later. ⛔ For a seat-bearing role this refuses unless the caller could grant that seat's organisation role themselves. The check has to happen here rather than at redemption, because by then the person redeeming is a stranger and there is no principal whose privileges could bound the grant.

Vigezo

Jina	Aina	Inayohitajika	Kilicho hiki
`boardId (path)`	`Uuid`	Ndiyo	Project board ID (UUIDv7).

Mwili wa ombi

Jina	Aina	Inayohitajika	Kilicho hiki
`role`	`AgencyBoardInviteRole`	Hapana	—
`label`	`string`	Hapana	—
`expires_in_days`	`integer`	Hapana	—
`max_uses`	`integer`	Hapana	Omit for an unlimited link.

Majibu

Jina	Aina	Inayohitajika	Kilicho hiki
`id`	`Uuid`	Ndiyo	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Ndiyo	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`role`	`AgencyBoardInviteRole`	Ndiyo	What a share link grants. `viewer` is link-only: it creates no board seat and no organisation membership, because it grants no identity — it is read-through-the-token, which…
`token`	`string`	Hapana	The full link token. ⛔ Present on the create response and NOWHERE ELSE. Only its SHA-256 digest is stored, so nothing can re-derive it — a screen that needs it must keep it…
`token_prefix`	`string`	Ndiyo	The first few characters, so a manager with three links open can tell them apart. Far too short to shorten the search space of the secret part.
`label`	`string`	Hapana	A note the manager typed. Never shown to the recipient.
`member_org_id`	`string`	Hapana	The organisation a seat from this link belongs to. `null` for `viewer`, which seats nobody.
`expires_at`	`string`	Ndiyo	When the link stops admitting new people. ⛔ Expiry does not evict anybody who already joined — a colleague who joined in March must not lose the board in April because the s…
`max_uses`	`integer`	Hapana	`null` is unlimited. `1` makes the link single-use.
`uses`	`integer`	Ndiyo	Seats created through this link. A repeat visit by somebody already on the board does not count, so a client who bookmarks the link cannot exhaust it.
`revoked_at`	`string`	Hapana	—
`last_used_at`	`string`	Hapana	—
`created_at`	`string`	Ndiyo	—
`is_live`	`boolean`	Ndiyo	Whether the link may admit somebody new right now — not revoked, not expired, not exhausted. Computed, so a caller never has to re-implement all three conditions.

Hitilafu ambazo mwisho huu unaweza kurudisha

401 · 403 · 404 · 422

POST /v1/agency/boards/{boardId}/invites