Desk

Share a hosted project with an organization

Changed on

Every member of the organization sees the project in their list and may open, edit, compile and run the agent on it, and reads the documents its files were indexed as. A project is shared with one organization at a time; this replaces any other. Only the project's owner shares it, and only with an organization the owner belongs to: an admin of the organization it is shared with may stop sharing it, never move it, and the documents its files were indexed as, to another. A project connected to a knowledge base that holds a file taken from a document of another organization is refused (409); shared, it takes only the organization's documents.

put/api/v0/desk/projects/{project_id}/share

Request

Path parameters

project_idstring uuid required

Request body

organization_idstring uuid required

Response

Successful Response

idstring uuid required
namestring required
created_atstring date-time required
updated_atstring date-time required
revisioninteger required

Moves on every change to the project's files.

file_countinteger required
total_bytesinteger required
is_ownerboolean required

The caller created this project.

can_manageboolean required

The caller may rename, delete and unshare the project: its owner, or an admin of the organization it is shared with. Sharing it, or moving it to another organization, is the owner's alone (is_owner).

owner_emailstring nullable

The owner's address, on a project the caller does not own.

Changes