agency-board
POST /v1/agency/boards/{boardId}/invites
Mint a copy-paste link to this board.
Tabbatar da Asali
Aiko da maɓallin API a matsayin bearer token. Wannan ma'anar ba ta bayyana takamaiman izini ba a cikin ƙayyadaddun bayanai, don haka ba wa maɓallin ku mafi ƙarancin abin da yake buƙata kuma ku bincika amsar maimakon yin zato.
Wannan wurin ƙarewa ba ya buƙatar ID na ƙungiya. Maɓallin ku ya riga ya gano ƙungiyar da yake ciki, kuma an iyakance amsa a kanta.
Gwada
May gurbin komai da ke cikin kusurwa da ƙimar ka, kuma may gurbin maballi da maballi daga allon sarrafa ka.
curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/invites \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'An shiga? Na'urar sarrafa API da ke cikin sashin kulawarka tana cika ainihin lambar ƙungiyarka da maɓallinka naka, sannan tana gudanar da buƙatar a kan ainihin API don haka zaka iya ganin amsar gaske. Buɗe wannan tashar a cikin na'urar kula da API
Bayani
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.
Sigogi
| Suna | Nau'i | Ana buƙata | Abin da yake |
|---|---|---|---|
boardId (path) | Uuid | Eh | Project board ID (UUIDv7). |
Jikin buƙata
| Suna | Nau'i | Ana buƙata | Abin da yake |
|---|---|---|---|
role | AgencyBoardInviteRole | A'a | — |
label | string | A'a | — |
expires_in_days | integer | A'a | — |
max_uses | integer | A'a | Omit for an unlimited link. |
Martani
| Suna | Nau'i | Ana buƙata | Abin da yake |
|---|---|---|---|
id | Uuid | Eh | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Eh | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
role | AgencyBoardInviteRole | Eh | 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 | A'a | 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 | Eh | 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 | A'a | A note the manager typed. Never shown to the recipient. |
member_org_id | string | A'a | The organisation a seat from this link belongs to. `null` for `viewer`, which seats nobody. |
expires_at | string | Eh | 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 | A'a | `null` is unlimited. `1` makes the link single-use. |
uses | integer | Eh | 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 | A'a | — |
last_used_at | string | A'a | — |
created_at | string | Eh | — |
is_live | boolean | Eh | 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. |
Kuskuren da wannan matsaya za ta iya maido wa
401 · 403 · 404 · 422