Document Platform
Invite Requests

Submit a request to invite someone to the workspace

Persists a pending request and sends an email to the single org admin chosen by the requester (validated server-side against the live admin set). The admin acts on the email (or the Access Control → Requests tab) by opening the prefilled invite dialog and sending normally, which resolves the request.

post/invite-requests/

Request

  • Base URL: http://localhost:9000
  • URL: http://localhost:9000/invite-requests/
  • Auth: API key in header x-api-key

Request body

customerIdstring uuid required
targetAdminIdstring uuid required
resourceType'building' | 'collection' | 'organization' required
resourceIdsstring[] required
relation'read' | 'edit' | 'upload' required
emailsstring[] required
messagestring required

Response

Default Response

notifiedAdminCountinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.