agency-board
POST /v1/agency/boards/{boardId}/invites
Mint a copy-paste link to this board.
Xaqiijinta aqoonsiga
U dir fure API ahaan calaamad muujisa (bearer token). Barta dhammaadka ee kani ma caysino luqad ahaan oggolaansho gaar ah oo ku dhex jirta qeexidda, markaa sii furahaaga inta ugu yar ee uu u baahan yahay oo fiiri jawaabta halka aad wax ka qaadan lahayd.
Boggan ma qaato aqoonsiga ururka. Furahaagu wuxuu horay u aqoonsanayaa ururka uu ka tirsan yahay, jawaabtuna waxay ku kooban tahay halkaas.
Isku day
Ku beddel wax kasta oo ku dhex jira qeebaha xaglaha ah qiimayaashaada, sidoo kalena haystaaha furaha ku beddel fure ka dhex muuqda dashboordigaaga.
curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/invites \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Ma sign-garaysay? Qalabka API ee ku jira dashboard-kaagu wuxuu buuxiyaa aqoonsigaaga ururka ee dhabta ah iyo furahaaga gaarka ah, wuxuuna ku shaqeysiiyaa codsiga API-ga nool si aad u aragto jawaabta dhabta ah. Kani ka fur barta kontoroolka ee API
Details
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.
Cabiraha
| Magaca | Nooc | Loo baahan yahay | Maxay tahay |
|---|---|---|---|
boardId (path) | Uuid | Haa | Project board ID (UUIDv7). |
Codsiga jidhkiisa
| Magaca | Nooc | Loo baahan yahay | Maxay tahay |
|---|---|---|---|
role | AgencyBoardInviteRole | Maya | — |
label | string | Maya | — |
expires_in_days | integer | Maya | — |
max_uses | integer | Maya | Omit for an unlimited link. |
Jawaab
| Magaca | Nooc | Loo baahan yahay | Maxay tahay |
|---|---|---|---|
id | Uuid | Haa | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Haa | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
role | AgencyBoardInviteRole | Haa | 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 | Maya | 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 | Haa | 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 | Maya | A note the manager typed. Never shown to the recipient. |
member_org_id | string | Maya | The organisation a seat from this link belongs to. `null` for `viewer`, which seats nobody. |
expires_at | string | Haa | 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 | Maya | `null` is unlimited. `1` makes the link single-use. |
uses | integer | Haa | 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 | Maya | — |
last_used_at | string | Maya | — |
created_at | string | Haa | — |
is_live | boolean | Haa | 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. |
Cilladaha ay bartaani soo celin karto
401 · 403 · 404 · 422