kustomer-client
    Preparing search index...

    Type Alias UpdateConversationData

    type UpdateConversationData = {
        body?:
            | {
                assignedTeams?: string[];
                assignedUsers?: string[];
                custom?: { [key: string]: never };
                defaultLang?: string | null;
                deleted?: boolean | null;
                direction?: "in" | "out";
                ended?: boolean;
                endedAt?: string;
                endedBy?: string;
                endedByType?: "user" | "customer";
                endedReason?: string;
                externalId?: string | null;
                locked?: boolean;
                name?: string | null;
                priority?: number;
                queue?:
                    | unknown & { external?: "amazon-connect"; id?: string }
                    | unknown & { external?: "amazon-connect"; id?: string | null };
                replyChannel?: string | null;
                rev?: number;
                satisfaction?: number | null;
                satisfactionLevel?: {
                    channel?:
                        | "email"
                        | "sms"
                        | "chat"
                        | "facebook"
                        | "twitter-dm"
                        | "twitter-tweet"
                        | "voice"
                        | "instagram"
                        | "instagram-comment"
                        | "whatsapp"
                        | "form";
                    createdAt: string;
                    firstAnswer?: string;
                    form?: string;
                    formResponse?: string;
                    rating?: number;
                    scheduledFor?: string;
                    score?: 0
                    | 1;
                    sentAt?: string;
                    sentBy?: string;
                    sentByTeams?: string[];
                    status:
                        | "scheduled"
                        | "offered"
                        | "rated"
                        | "commented"
                        | "canceled"
                        | "unresponded";
                    updatedAt?: string;
                };
                sentiment?: { confidence: number; polarity: -1
                | 0
                | 1 };
                snooze?: { status: "scheduled" | "canceled" | "elapsed"; time?: string };
                status?: "open" | "snoozed" | "done";
                subStatus?: string;
                suggestedShortcuts?: { confidence: number; shortcutId: string }[];
                suggestedTags?: { confidence: number; tag: string }[];
                tags?: string[];
            }
            | { customer?: string };
        path: { id: string };
        query?: { replace?: boolean };
        url: "/conversations/{id}";
    }
    Index

    Properties

    Properties

    body?:
        | {
            assignedTeams?: string[];
            assignedUsers?: string[];
            custom?: { [key: string]: never };
            defaultLang?: string | null;
            deleted?: boolean | null;
            direction?: "in" | "out";
            ended?: boolean;
            endedAt?: string;
            endedBy?: string;
            endedByType?: "user" | "customer";
            endedReason?: string;
            externalId?: string | null;
            locked?: boolean;
            name?: string | null;
            priority?: number;
            queue?:
                | unknown & { external?: "amazon-connect"; id?: string }
                | unknown & { external?: "amazon-connect"; id?: string | null };
            replyChannel?: string | null;
            rev?: number;
            satisfaction?: number | null;
            satisfactionLevel?: {
                channel?:
                    | "email"
                    | "sms"
                    | "chat"
                    | "facebook"
                    | "twitter-dm"
                    | "twitter-tweet"
                    | "voice"
                    | "instagram"
                    | "instagram-comment"
                    | "whatsapp"
                    | "form";
                createdAt: string;
                firstAnswer?: string;
                form?: string;
                formResponse?: string;
                rating?: number;
                scheduledFor?: string;
                score?: 0
                | 1;
                sentAt?: string;
                sentBy?: string;
                sentByTeams?: string[];
                status:
                    | "scheduled"
                    | "offered"
                    | "rated"
                    | "commented"
                    | "canceled"
                    | "unresponded";
                updatedAt?: string;
            };
            sentiment?: { confidence: number; polarity: -1
            | 0
            | 1 };
            snooze?: { status: "scheduled" | "canceled" | "elapsed"; time?: string };
            status?: "open" | "snoozed" | "done";
            subStatus?: string;
            suggestedShortcuts?: { confidence: number; shortcutId: string }[];
            suggestedTags?: { confidence: number; tag: string }[];
            tags?: string[];
        }
        | { customer?: string }
    path: { id: string }

    Type declaration

    • id: string

      Unique ID of the conversation.

    query?: { replace?: boolean }

    Type declaration

    • Optionalreplace?: boolean

      Set to true to update the document. Otherwise, performs the same update as a PATCH request. Default value: false.

    url: "/conversations/{id}"