Share a project
Changed onShares the project read-only with an email address. Owner-only.
If the email has an Elicit account, they get read access immediately and status is registered. Otherwise a pending invitation is created and status is invited; inviting people without an account requires that your plan allows it.
An email that already has edit access keeps it: nothing is downgraded, and the response reports their role as writer. Repeating a share is safe, including for a recipient whose organization also has edit access to the project.
A 400 means the request can't produce a share: self_share for your own address, already_has_org_access when the recipient's organization already has edit access to the project so a read-only share would do nothing. A 403 means the share is not allowed: cap_exceeded when the project has reached its recipient limit, gate_denied when your plan cannot invite people without an Elicit account.
Example
curl -X POST https://elicit.com/api/v2/projects/{projectId}/shares \
-H "Authorization: Bearer elk_live_your_key_here" \
-H "Content-Type: application/json" \
-d '{"email": "colleague@example.com"}'
Request
- Base URLhttps://elicit.com/api/v2
- URLhttps://elicit.com/api/v2/projects/{projectId}/shares
- AuthHTTP bearer
Path parameters
The project ID (UUID) from GET /projects or POST /projects
Request body
Example request
{
"email": "colleague@example.com"
}Response
The share that now exists.
Example response
{
"projectId": "9c1f6a7e-5d24-4a3b-9f0e-1b2c3d4e5f60",
"share": {
"email": "colleague@example.com"
}
}Changes
- info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status
- info
- info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status
- info