agency-board
POST /v1/agency/boards/{boardId}/invites
Mint a copy-paste link to this board.
Doğrulama
API açarını bearer token kimi göndərin. Bu səhifə spresifikasiyada xüsusi icazə tələb etmir, buna görə də açarınıza ehtiyac duyduğu minimum səviyyədə icazə verin və güman etmək əvəzinə cavabı yoxlayın.
Bu endpoint heç bir təşkilat ID-si tələb etmir. Sizin açarınız artıq aid olduğu təşkilatı müəyyən edir və cavab həmin təşkilat üçün məhdudlaşdırılır.
Sınaqdan keçir
Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.
curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/invites \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın
Təfərrüatlar
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.
Parametrlər
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
boardId (path) | Uuid | Bəli | Project board ID (UUIDv7). |
Sorğu gövdəsi
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
role | AgencyBoardInviteRole | Xeyr | — |
label | string | Xeyr | — |
expires_in_days | integer | Xeyr | — |
max_uses | integer | Xeyr | Omit for an unlimited link. |
Cavab
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
id | Uuid | Bəli | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Bəli | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
role | AgencyBoardInviteRole | Bəli | 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 | Xeyr | 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 | Bəli | 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 | Xeyr | A note the manager typed. Never shown to the recipient. |
member_org_id | string | Xeyr | The organisation a seat from this link belongs to. `null` for `viewer`, which seats nobody. |
expires_at | string | Bəli | 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 | Xeyr | `null` is unlimited. `1` makes the link single-use. |
uses | integer | Bəli | 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 | Xeyr | — |
last_used_at | string | Xeyr | — |
created_at | string | Bəli | — |
is_live | boolean | Bəli | 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. |
Bu son nöqtənin qaytara biləcəyi xətalar
401 · 403 · 404 · 422