agency-board

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

Mint a copy-paste link to this board.

Նույնականացում

Ուղարկեք API բանալին որպես bearer թոքեն։ Այս վերջնակետը բնութագրում չի նշում որոշակի թույլտվության մասին, ուստի տվեք ձեր բանալուն նվազագույն անհրաժեշտը և ենթադրություններ անելու փոխարեն ստուգեք պատասխանը:

Այս վերջնակետը կազմակերպության ID չի ընդունում: Ձեր բանալին արդեն իսկ նույնականացնում է այն կազմակերպությունը, որին պատկանում է, և պատասխանը սահմանափակված է դրանով:

Փորձել

Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:

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

Մուտք գործե՞լ եք: Ձեր վահանակի API վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ API-ի դեմ, որպեսզի կարողանաք տեսնել փաստացի պատասխանը: Բացեք այս վերջնակետը API վահանակում

Մանրամասներ

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.

Պարամետրեր

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`boardId (path)`	`Uuid`	Այո	Project board ID (UUIDv7).

Հարցման մարմին

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`role`	`AgencyBoardInviteRole`	Ոչ	—
`label`	`string`	Ոչ	—
`expires_in_days`	`integer`	Ոչ	—
`max_uses`	`integer`	Ոչ	Omit for an unlimited link.

Պատասխան

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`id`	`Uuid`	Այո	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Այո	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`role`	`AgencyBoardInviteRole`	Այո	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`	Ոչ	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`	Այո	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 note the manager typed. Never shown to the recipient.
`member_org_id`	`string`	Ոչ	The organisation a seat from this link belongs to. `null` for `viewer`, which seats nobody.
`expires_at`	`string`	Այո	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`	Ոչ	`null` is unlimited. `1` makes the link single-use.
`uses`	`integer`	Այո	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`	Ոչ	—
`last_used_at`	`string`	Ոչ	—
`created_at`	`string`	Այո	—
`is_live`	`boolean`	Այո	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.

Այս վերջնակետի կողմից վերադարձվող սխալները

401 · 403 · 404 · 422

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