Invite to Data Room
POST/v1/fundraisings/:id/invite-to-data-room
Invites the prospect on the Fund Admin closing linked to this fundraising to the fund's data room, so Fund Admin emails the collaborators. Send the prospect details in the body to stage a new prospect, or omit the body to reuse the prospect already staged for this fundraising (typically by Send Subscription Docs); with no body and no staged prospect the request fails with PROSPECT_DETAILS_REQUIRED. Responds 202 once the prospect is staged and the invite dispatched — the invite runs after the response and its outcome is NOT reported here, so invitedEmails names who is being invited rather than who was reached; a 202 does not mean the email was delivered. An invite is recorded optimistically, so an immediate re-send is refused with ALREADY_SENT; if the invite fails that record is rolled back and a re-send is accepted. Requires the organization to have the Carta integration enabled. Failures other than 403 carry a machine-readable code alongside message. Note PROSPECT_PERSIST_FAILED must never be retried — a retry stages a duplicate prospect on a live closing — and FA_REJECTED_REQUEST cannot succeed on identical input.
Request
Responses
- 202
- 400
- 401
- 403
- 404
- 409
- 422
- 500
- 502
Prospect staged and the data-room invite dispatched
Invalid request parameters
Invalid or missing API key
Read-only API key, Carta integration disabled, or Fund Admin permission denied
Fundraising not found
The prospect was already invited to the data room for this fundraising (code: ALREADY_SENT)
Fund not mapped, Carta identity missing, closings not set up, Fund Admin refused the request, or the body was omitted with no prospect staged (code: PROSPECT_DETAILS_REQUIRED)
Internal server error, or the prospect was created in Fund Admin but not recorded in CRM (code: PROSPECT_PERSIST_FAILED — do not retry)
Fund Admin unreachable