kustomer-client
    Preparing search index...

    Type Alias UpdateDraftData

    type UpdateDraftData = {
        body?:
            | {
                app?: "gmail"
                | "postmark";
                auto?: boolean;
                bcc?: { email: string; name?: string }[];
                body?: string;
                cc?: { email: string; name?: string }[];
                channel: "email";
                conversation?: string;
                customer?: string;
                from?: { email: string; name?: string };
                headers?: { name: string; value?: string }[];
                htmlBody?: string;
                kbArticles?: string[];
                lang?: string | null;
                payload?: { [key: string]: unknown };
                replyTo?: string;
                scheduled?: boolean;
                sendAt?: string | null;
                shortcuts?: string[];
                source?: "bulk" | "satisfaction" | "biz-rules";
                subject?: string;
                template?: string | null;
                templateType?:
                    | "email-reply"
                    | "email-autoresponse"
                    | "email-satisfaction";
                to?: | { email: string; name?: string }[]
                | { email: string; name?: string };
            }
            | {
                app?: "twilio"
                | "zipwhip"
                | "messagebird";
                auto?: boolean;
                body?: string;
                channel: "sms";
                conversation?: string;
                customer?: string;
                from?: string;
                kbArticles?: string[];
                lang?: string | null;
                payload?: { [key: string]: unknown };
                scheduled?: boolean;
                sendAt?: string | null;
                shortcuts?: string[];
                source?: "bulk" | "satisfaction" | "biz-rules";
                to?: string;
            }
            | {
                app: "twilio_whatsapp"
                | "messagebird"
                | "whatsapp";
                auto?: boolean;
                body?: string;
                channel: "whatsapp";
                conversation?: string;
                customer?: string;
                from?: string;
                kbArticles?: string[];
                lang?: string | null;
                payload?: { [key: string]: unknown };
                scheduled?: boolean;
                sendAt?: string | null;
                shortcuts?: string[];
                source?: "bulk" | "satisfaction" | "biz-rules";
                to?: string;
            }
            | {
                app?: "chat"
                | "smooch";
                attachments?: string[];
                auto?: boolean;
                body?: string;
                channel: "chat";
                conversation?: string;
                customer?: string;
                from?: string;
                kbArticles?: string[];
                lang?: string | null;
                messageTemplate?:
                    | { body: string; id?: string; templateType: "text" }
                    | {
                        actions: {
                            displayText: string;
                            value: string;
                            valueType: "url" | "text";
                        }[];
                        body?: string;
                        id?: string;
                        templateType: "quick_replies";
                    }
                    | {
                        actions: {
                            displayText: string;
                            value: string;
                            valueType: "url"
                            | "text";
                        }[];
                        articles: {
                            attributes?: { [key: string]: unknown };
                            id: string;
                            type?: string;
                        }[];
                        body?: string;
                        followupText?: string;
                        id?: string;
                        templateType: "deflection";
                    }
                    | {
                        actions: { tree: { [key: string]: unknown } };
                        body?: string;
                        id?: string;
                        templateType: "mll";
                    };
                payload?: { [key: string]: unknown };
                responseButtons?: { label: string; value: string }[];
                scheduled?: boolean;
                sendAt?: string | null;
                shortcuts?: string[];
                source?: "bulk" | "satisfaction" | "biz-rules";
                to?: string;
            }
            | {
                auto?: boolean;
                body?: string;
                channel: "facebook";
                conversation?: string;
                customer?: string;
                from?: string;
                kbArticles?: string[];
                lang?: string
                | null;
                payload?: { [key: string]: unknown };
                scheduled?: boolean;
                sendAt?: string | null;
                shortcuts?: string[];
                source?: "bulk" | "satisfaction" | "biz-rules";
                to?: string;
            }
            | {
                auto?: boolean;
                body?: string;
                channel: "twitter-tweet";
                conversation?: string;
                customer?: string;
                from?: string;
                kbArticles?: string[];
                lang?: string
                | null;
                payload?: { [key: string]: unknown };
                scheduled?: boolean;
                sendAt?: string;
                shortcuts?: string[];
                source?: "bulk" | "satisfaction" | "biz-rules";
                to?: string;
            }
            | {
                auto?: boolean;
                body?: string;
                channel: "twitter-dm";
                conversation?: string;
                customer?: string;
                from?: string;
                kbArticles?: string[];
                lang?: string
                | null;
                payload?: { [key: string]: unknown };
                scheduled?: boolean;
                sendAt?: string;
                shortcuts?: string[];
                source?: "bulk" | "satisfaction" | "biz-rules";
                to?: string;
            }
            | {
                body?: string;
                channel: "note";
                conversation?: string;
                customer?: string;
                kbArticles?: string[];
                lang?: string
                | null;
                payload?: { [key: string]: unknown };
                scheduled?: boolean;
                sendAt?: string | null;
                shortcuts?: string[];
                source?: "bulk" | "biz-rules";
                userMentions?: { team?: string; user?: string }[];
            }
            | {
                auto?: boolean;
                body?: string;
                channel: "instagram";
                conversation?: string;
                customer?: string;
                from?: string;
                kbArticles?: string[];
                lang?: string
                | null;
                payload?: { [key: string]: unknown };
                scheduled?: boolean;
                sendAt?: string | null;
                shortcuts?: string[];
                source?: "bulk" | "satisfaction" | "biz-rules";
                to?: string;
            };
        path: { id: string };
        query?: never;
        url: "/drafts/{id}";
    }
    Index

    Properties

    Properties

    body?:
        | {
            app?: "gmail"
            | "postmark";
            auto?: boolean;
            bcc?: { email: string; name?: string }[];
            body?: string;
            cc?: { email: string; name?: string }[];
            channel: "email";
            conversation?: string;
            customer?: string;
            from?: { email: string; name?: string };
            headers?: { name: string; value?: string }[];
            htmlBody?: string;
            kbArticles?: string[];
            lang?: string | null;
            payload?: { [key: string]: unknown };
            replyTo?: string;
            scheduled?: boolean;
            sendAt?: string | null;
            shortcuts?: string[];
            source?: "bulk" | "satisfaction" | "biz-rules";
            subject?: string;
            template?: string | null;
            templateType?: "email-reply" | "email-autoresponse" | "email-satisfaction";
            to?: { email: string; name?: string }[] | { email: string; name?: string };
        }
        | {
            app?: "twilio"
            | "zipwhip"
            | "messagebird";
            auto?: boolean;
            body?: string;
            channel: "sms";
            conversation?: string;
            customer?: string;
            from?: string;
            kbArticles?: string[];
            lang?: string | null;
            payload?: { [key: string]: unknown };
            scheduled?: boolean;
            sendAt?: string | null;
            shortcuts?: string[];
            source?: "bulk" | "satisfaction" | "biz-rules";
            to?: string;
        }
        | {
            app: "twilio_whatsapp"
            | "messagebird"
            | "whatsapp";
            auto?: boolean;
            body?: string;
            channel: "whatsapp";
            conversation?: string;
            customer?: string;
            from?: string;
            kbArticles?: string[];
            lang?: string | null;
            payload?: { [key: string]: unknown };
            scheduled?: boolean;
            sendAt?: string | null;
            shortcuts?: string[];
            source?: "bulk" | "satisfaction" | "biz-rules";
            to?: string;
        }
        | {
            app?: "chat"
            | "smooch";
            attachments?: string[];
            auto?: boolean;
            body?: string;
            channel: "chat";
            conversation?: string;
            customer?: string;
            from?: string;
            kbArticles?: string[];
            lang?: string | null;
            messageTemplate?:
                | { body: string; id?: string; templateType: "text" }
                | {
                    actions: {
                        displayText: string;
                        value: string;
                        valueType: "url" | "text";
                    }[];
                    body?: string;
                    id?: string;
                    templateType: "quick_replies";
                }
                | {
                    actions: {
                        displayText: string;
                        value: string;
                        valueType: "url"
                        | "text";
                    }[];
                    articles: {
                        attributes?: { [key: string]: unknown };
                        id: string;
                        type?: string;
                    }[];
                    body?: string;
                    followupText?: string;
                    id?: string;
                    templateType: "deflection";
                }
                | {
                    actions: { tree: { [key: string]: unknown } };
                    body?: string;
                    id?: string;
                    templateType: "mll";
                };
            payload?: { [key: string]: unknown };
            responseButtons?: { label: string; value: string }[];
            scheduled?: boolean;
            sendAt?: string | null;
            shortcuts?: string[];
            source?: "bulk" | "satisfaction" | "biz-rules";
            to?: string;
        }
        | {
            auto?: boolean;
            body?: string;
            channel: "facebook";
            conversation?: string;
            customer?: string;
            from?: string;
            kbArticles?: string[];
            lang?: string
            | null;
            payload?: { [key: string]: unknown };
            scheduled?: boolean;
            sendAt?: string | null;
            shortcuts?: string[];
            source?: "bulk" | "satisfaction" | "biz-rules";
            to?: string;
        }
        | {
            auto?: boolean;
            body?: string;
            channel: "twitter-tweet";
            conversation?: string;
            customer?: string;
            from?: string;
            kbArticles?: string[];
            lang?: string
            | null;
            payload?: { [key: string]: unknown };
            scheduled?: boolean;
            sendAt?: string;
            shortcuts?: string[];
            source?: "bulk" | "satisfaction" | "biz-rules";
            to?: string;
        }
        | {
            auto?: boolean;
            body?: string;
            channel: "twitter-dm";
            conversation?: string;
            customer?: string;
            from?: string;
            kbArticles?: string[];
            lang?: string
            | null;
            payload?: { [key: string]: unknown };
            scheduled?: boolean;
            sendAt?: string;
            shortcuts?: string[];
            source?: "bulk" | "satisfaction" | "biz-rules";
            to?: string;
        }
        | {
            body?: string;
            channel: "note";
            conversation?: string;
            customer?: string;
            kbArticles?: string[];
            lang?: string
            | null;
            payload?: { [key: string]: unknown };
            scheduled?: boolean;
            sendAt?: string | null;
            shortcuts?: string[];
            source?: "bulk" | "biz-rules";
            userMentions?: { team?: string; user?: string }[];
        }
        | {
            auto?: boolean;
            body?: string;
            channel: "instagram";
            conversation?: string;
            customer?: string;
            from?: string;
            kbArticles?: string[];
            lang?: string
            | null;
            payload?: { [key: string]: unknown };
            scheduled?: boolean;
            sendAt?: string | null;
            shortcuts?: string[];
            source?: "bulk" | "satisfaction" | "biz-rules";
            to?: string;
        }
    path: { id: string }

    Type declaration

    • id: string

      Unique draft ID.

    query?: never
    url: "/drafts/{id}"