/v1/collaborationRequests/sendRequest
—
post

Send a collaboration request to invite a user to your workspace. The recipient will receive an email notification and can accept or decline the invitation through the platform.

Path Parameters
Not Applicable
Request Headers
HttpEndpointRequestHeaders_AuthRequired_JsonContentType

FieldTypeRequiredDescription
AuthorizationstringYes

Access token

Example: Bearer <token>

Content-TypestringYes

HTTP JSON request content type

Example: application/json

Request Query
Not Applicable
Request Body
SendCollaborationRequestEndpointParams

Parameters needed to send a collaboration request to invite someone to your workspace.

{
workspaceId?: string
recipientEmail: string
message: string
expires?: number
}
200 — Response Headers
HttpEndpointResponseHeaders_ContentType_ContentLength

FieldTypeRequiredDescription
Content-TypestringYes

HTTP JSON response content type

Example: application/json

Content-LengthstringYes

HTTP response content length in bytes

Example: 1024

200 — Response Body
SendCollaborationRequestEndpointResult

Response returned after successfully sending a collaboration request. Contains the created request details.

{
request: CollaborationRequestForWorkspace
}
CollaborationRequestForWorkspace

A collaboration request as seen by the workspace owner. Contains details about who was invited and the current status of the invitation.

{
resourceId: string
createdBy: Agent
createdAt: number
lastUpdatedBy: Agent
lastUpdatedAt: number
isDeleted: boolean
deletedAt?: number
deletedBy?: Agent
workspaceId: string
recipientEmail: string
message: string
expiresAt?: number
workspaceName: string
readAt?: number
status: string
statusDate: number
}
Agent

Represents a user or system entity that performed an action (e.g., created or updated a resource)

{
agentId: string
agentType: string
}
4XX or 5XX — Response Headers
HttpEndpointResponseHeaders_ContentType_ContentLength

FieldTypeRequiredDescription
Content-TypestringYes

HTTP JSON response content type

Example: application/json

Content-LengthstringYes

HTTP response content length in bytes

4XX or 5XX — Response Body
EndpointErrorResult

Endpoint error result

{
errors?: Array<ExternalError>
}
ExternalError

{
message: string
}