Remove tags from the selected conversations.
This function is only available on context of types
singleConversation,multiConversations, andmessageComposer
function untag(tagIds: ReadonlyArray<string>, cancelToken?: CancelToken): Promise<void>;
Parameters
| Parameter | Type | Description |
|---|---|---|
tagIds | Array of String | List of the tag IDs to add. |
cancelToken | CancelToken (optional) | Token to cancel the request. |
Return value
The function returns a promise that resolves once the tags are removed.
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. |