Assign or unassign the selected conversations.
This function is only available on context of types
singleConversation
,multiConversations
, andmessageComposer
function assign(teammateId: string | null, cancelToken?: CancelToken): Promise<void>;
Parameters
Parameter | Type | Description |
---|---|---|
teammateId | String | null | ID of the teammate to assign the conversation to. |
cancelToken | CancelToken (optional) | Token to cancel the request. |
To unassign the selected conversations, set the teammateId
parameter to null
.
Return value
The function returns a promise that resolves once Front receives the request.
Errors
Message | Description |
---|---|
The draft's conversation is not selected. | This error applies to composer plugins. It occurs when the messageComposer context for composer plugins does not have access to the conversation. To avoid this error, disable the functionality of this method whenever the conversation property does not exist in the messageComposer context. Learn more in the Context topic. |