agency-board

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

Mint a copy-paste link to this board.

ማረጋገጫ

የኤፒአይ ቁልፍ (API key) እንደ ቢረር ቶከን (bearer token) ይላኩ። ይህ የመጨረሻ ነጥብ (endpoint) በመግለጫው ውስጥ የተወሰነ ፈቃድ አልገለጸም፣ ስለዚህ ከማሰብ ይልቅ ለቁልፍዎ የሚያስፈልገውን አነስተኛ ፈቃድ ይስጡት እና ምላሹን ያረጋግጡ።

ይህ ኤንድፖይ መክፈቻ (endpoint) የድርጅት መታወቂያ (organisation id) አይወስድም። የእርስዎ ቁልፍ (key) እሱ የሚመለከተውን ድርጅት አስቀድሞ ይለያል፣ እና ምላሹም ለዚሁ የተወሰነ ነው።

ሞክሩት

በቅንፍ ውስጥ ያለውን ማንኛውንም ነገር በራስዎ እሴቶች ይተኩ፣ እና ቁልፍ ቦታ ያዢውን ከዳሽቦርድዎ በመጣ ቁልፍ ይተኩ።

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

ገብተዋል? የመቆጣጠሪያ ማዕከልዎ ውስጥ ያለው የኤፒአይ ኮንሶል ትክክለኛውን የድርጅት መታወቂያዎን እና የራስዎን ቁልፍ ይሞላል፣ እና ትክክለኛውን ምላሽ ማየት እንዲችሉ ጥያቄውን በቀጥታ ከሚሰራው ኤፒአይ ጋር ያካሂደዋል። ይህን ኤንድፖይንት በ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