DoCurious API Reference / types / VendorInviteLink

Interface: VendorInviteLink

Defined in: types/vendor.types.ts:344

A shareable invite link for joining a vendor's team with a specified role.

Remarks

The owner role cannot be assigned via invite links. Links can have a limited number of uses or be unlimited (usesRemaining: null).

Properties

createdAt

createdAt: string

Defined in: types/vendor.types.ts:352

---

createdBy

createdBy: string

Defined in: types/vendor.types.ts:351

---

expiresAt

expiresAt: string

Defined in: types/vendor.types.ts:353

---

id

id: string

Defined in: types/vendor.types.ts:345

---

isActive

isActive: boolean

Defined in: types/vendor.types.ts:356

---

role

role: "admin" | "editor"

Defined in: types/vendor.types.ts:350

Role assigned to anyone who joins via this link (owner cannot be invited)

---

token

token: string

Defined in: types/vendor.types.ts:348

Unique token included in the invite URL

---

usesRemaining

usesRemaining: number | null

Defined in: types/vendor.types.ts:355

Number of remaining uses; null means unlimited

---

vendorId

vendorId: string

Defined in: types/vendor.types.ts:346