fimidara — docs

`FimidaraEndpoints.collaborationRequests.sendRequest`

Parameters

props—Required

{

authToken: string

body: SendCollaborationRequestEndpointParams

}

SendCollaborationRequestEndpointParams

—Optional

{

workspaceId?: string

recipientEmail: string

message: string

expires?: number

}

Result

—Optional

{

headers: Headers

body?: SendCollaborationRequestEndpointResult

}

SendCollaborationRequestEndpointResult

—Optional

{

request: CollaborationRequestForWorkspace

}

CollaborationRequestForWorkspace

—Optional

{

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

—Optional

{

agentId: string

agentType: string

}

Throws

—Required

Error thrown, if error is an endpoint error.

{

errors: Array<FimidaraEndpointErrorItem>

statusCode: number

statusText?: string

headers: Headers

}

FimidaraEndpointErrorItem

—Optional

Server error item.

{

name: string

message: string

field?: string

}

Loading...

FimidaraEndpoints.collaborationRequests.sendRequest

Parameters

SendCollaborationRequestEndpointParams

Result

SendCollaborationRequestEndpointResult

CollaborationRequestForWorkspace

Agent

Throws

FimidaraEndpointErrorItem

`FimidaraEndpoints.collaborationRequests.sendRequest`