setStatus

Set the status of the selected conversations.

πŸ“˜

This function is only available on context of types singleConversation, multiConversations, and messageComposer

function setStatus(status: string, cancelToken?: CancelToken): Promise<void>;

Parameters

ParameterTypeDescription
statusStringStatus of the conversation (cf: Conversation Status)
cancelTokenCancelToken (optional)Token to cancel the request.

Return value

The function returns a promise that resolves once Front receives the request.

Errors

MessageDescription
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.