Function appendTagsToConversation

appendTagsToConversation<ThrowOnError extends boolean = true>(
    options: Options<AppendTagsToConversationData, ThrowOnError>,
): RequestResult<
    {
        data: {
            attributes: {
                assignedTeams: unknown[];
                assignedUsers: unknown[];
                channels: unknown[];
                createdAt: string;
                direction: string;
                firstResponse: { [key: string]: unknown };
                lastMessageIn: { [key: string]: unknown };
                messageCount: number;
                modifiedAt: string;
                name: string;
                noteCount: number;
                outboundMessageCount: number;
                rev: number;
                satisfaction: number;
                sentiment: { [key: string]: unknown };
                status: string;
                suggestedTags: unknown[];
                tags: string[];
                updatedAt: string;
            };
            id: string;
            links: { self: string };
            relationships: {
                createdBy: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                customer: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                messages: { links: { self: string } };
                modifiedBy: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                org: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
    },
    unknown,
    ThrowOnError,
>
Append tags to conversation Adds tags to a conversation by the tag name and/or the unique ID of the conversation. Creates a new tag if a tag does not exist yet in your Kustomer organization.

To learn more, see Conversation tags in the Kustomer Help Center.

Any one of the following roles is required for this endpoint:

Legacy Role Equivalent Permission Set Role

org.user.conversation.write org.permission.conversation.update

Note

This endpoint is subject to Object Rate Limiting, which limits how many updates a single User can make to a single Conversation. See Rate limiting for more information.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<AppendTagsToConversationData, ThrowOnError>
Returns RequestResult<
    {
        data: {
            attributes: {
                assignedTeams: unknown[];
                assignedUsers: unknown[];
                channels: unknown[];
                createdAt: string;
                direction: string;
                firstResponse: { [key: string]: unknown };
                lastMessageIn: { [key: string]: unknown };
                messageCount: number;
                modifiedAt: string;
                name: string;
                noteCount: number;
                outboundMessageCount: number;
                rev: number;
                satisfaction: number;
                sentiment: { [key: string]: unknown };
                status: string;
                suggestedTags: unknown[];
                tags: string[];
                updatedAt: string;
            };
            id: string;
            links: { self: string };
            relationships: {
                createdBy: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                customer: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                messages: { links: { self: string } };
                modifiedBy: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                org: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
    },
    unknown,
    ThrowOnError,
>
- Defined in src/api/sdk.gen.ts:1383

Function appendTagsToConversation

Note

Type Parameters

Parameters

Settings

On This Page