kustomer-client
    Preparing search index...

    Type Alias CreateDraftByCustomerData

    type CreateDraftByCustomerData = {
        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 }[];
                kbArticles?: string[];
                lang?: string | null;
                payload?: { [key: string]: unknown };
                replyTo?: string;
                sendAt?: string | null;
                shortcuts?: string[];
                source?: "bulk" | "satisfaction";
                subject?: string;
                template?: string | null;
                to?:
                    | { email: string; name?: string }[]
                    | { email: string; name?: string };
            }
            | {
                app?: "twilio"
                | "zipwhip";
                auto?: boolean;
                body?: string;
                channel: "sms";
                conversation?: string;
                customer?: string;
                from?: string;
                kbArticles?: string[];
                lang?: string | null;
                payload?: { [key: string]: unknown };
                sendAt?: string | null;
                shortcuts?: string[];
                source?: "bulk" | "satisfaction";
                to?: string;
            }
            | {
                auto?: boolean;
                channel: "whatsapp";
                conversation?: string;
                customer?: string;
                from?: string;
                kbArticles?: string[];
                lang?: string
                | null;
                payload?: { [key: string]: unknown };
                sendAt?: string | null;
                shortcuts?: string[];
                source?: "bulk" | "satisfaction" | "biz-rules";
                to?: string;
            } & { app: "twilio_whatsapp"
            | "messagebird"
            | "whatsapp"; body: string }
            | {
                auto?: boolean;
                channel: "whatsapp";
                conversation?: string;
                customer?: string;
                from?: string;
                kbArticles?: string[];
                lang?: string | null;
                payload?: { [key: string]: unknown };
                sendAt?: string | null;
                shortcuts?: string[];
                source?: "bulk" | "satisfaction" | "biz-rules";
                to?: string;
            } & {
                app: "whatsapp";
                meta: {
                    interactive: | {
                        action: { button: string; sections: { rows: ...; title?: ... }[] };
                        body: { text: string };
                        footer?: { text: string };
                        header?: { text: string; type: "text" };
                        type: "list";
                    }
                    | {
                        action: { buttons: { reply: ...; type: ... }[] };
                        body: { text: string };
                        footer?: { text: string };
                        header?: { text: string; type: "text" };
                        type: "button";
                    };
                };
            }
            | {
                auto?: boolean;
                channel: "whatsapp";
                conversation?: string;
                customer?: string;
                from?: string;
                kbArticles?: string[];
                lang?: string
                | null;
                payload?: { [key: string]: unknown };
                sendAt?: string | null;
                shortcuts?: string[];
                source?: "bulk" | "satisfaction" | "biz-rules";
                to?: string;
            } & {
                app: "whatsapp";
                meta: {
                    components?: {
                        body?: { [key: string]: { text?: string; type?: "text" } };
                        buttons?: {
                            index: number;
                            sub_type: "url";
                            [key: string]: number | "url" | { text?: ...; type?: ... };
                        }[];
                        header?: | {
                            text: { [key: string]: { text?: ...; type?: ... } };
                            type: "text";
                        }
                        | { attachment: string; type: "image"
                        | "video"
                        | "document" };
                    };
                    template: string;
                };
            }
            | {
                attachments?: string[];
                auto?: boolean;
                body?: string;
                channel: "chat";
                conversation?: string;
                customer?: string;
                from?: string;
                kbArticles?: string[];
                lang?: string
                | null;
                payload?: { [key: string]: unknown };
                sendAt?: string | null;
                shortcuts?: string[];
                source?: "bulk" | "satisfaction";
                to?: string;
            }
            | {
                auto?: boolean;
                body?: string;
                channel: "facebook";
                conversation?: string;
                customer?: string;
                from?: string;
                kbArticles?: string[];
                lang?: string
                | null;
                payload?: { [key: string]: unknown };
                sendAt?: string | null;
                shortcuts?: string[];
                source?: "bulk" | "satisfaction";
                to?: string;
            }
            | {
                auto?: boolean;
                body?: string;
                channel: "twitter-tweet";
                conversation?: string;
                customer?: string;
                from?: string;
                kbArticles?: string[];
                lang?: string
                | null;
                payload?: { [key: string]: unknown };
                sendAt?: string;
                shortcuts?: string[];
                source?: "bulk" | "satisfaction";
                to?: string;
            }
            | {
                auto?: boolean;
                body?: string;
                channel: "twitter-dm";
                conversation?: string;
                customer?: string;
                from?: string;
                kbArticles?: string[];
                lang?: string
                | null;
                payload?: { [key: string]: unknown };
                sendAt?: string;
                shortcuts?: string[];
                source?: "bulk" | "satisfaction";
                to?: string;
            }
            | {
                body?: string;
                channel: "note";
                conversation?: string;
                customer?: string;
                kbArticles?: string[];
                lang?: string
                | null;
                payload?: { [key: string]: unknown };
                sendAt?: string | null;
                shortcuts?: string[];
                source?: "bulk";
                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 };
                sendAt?: string | null;
                shortcuts?: string[];
                source?: "bulk" | "satisfaction";
                to?: string;
            };
        path: { id: string };
        query?: never;
        url: "/customers/{id}/drafts";
    }
    Index

    Properties

    body? path query? url

    Properties

    Optionalbody

    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 }[];
            kbArticles?: string[];
            lang?: string | null;
            payload?: { [key: string]: unknown };
            replyTo?: string;
            sendAt?: string | null;
            shortcuts?: string[];
            source?: "bulk" | "satisfaction";
            subject?: string;
            template?: string | null;
            to?: { email: string; name?: string }[] | { email: string; name?: string };
        }
        | {
            app?: "twilio"
            | "zipwhip";
            auto?: boolean;
            body?: string;
            channel: "sms";
            conversation?: string;
            customer?: string;
            from?: string;
            kbArticles?: string[];
            lang?: string | null;
            payload?: { [key: string]: unknown };
            sendAt?: string | null;
            shortcuts?: string[];
            source?: "bulk" | "satisfaction";
            to?: string;
        }
        | {
            auto?: boolean;
            channel: "whatsapp";
            conversation?: string;
            customer?: string;
            from?: string;
            kbArticles?: string[];
            lang?: string
            | null;
            payload?: { [key: string]: unknown };
            sendAt?: string | null;
            shortcuts?: string[];
            source?: "bulk" | "satisfaction" | "biz-rules";
            to?: string;
        } & { app: "twilio_whatsapp"
        | "messagebird"
        | "whatsapp"; body: string }
        | {
            auto?: boolean;
            channel: "whatsapp";
            conversation?: string;
            customer?: string;
            from?: string;
            kbArticles?: string[];
            lang?: string | null;
            payload?: { [key: string]: unknown };
            sendAt?: string | null;
            shortcuts?: string[];
            source?: "bulk" | "satisfaction" | "biz-rules";
            to?: string;
        } & {
            app: "whatsapp";
            meta: {
                interactive: | {
                    action: { button: string; sections: { rows: ...; title?: ... }[] };
                    body: { text: string };
                    footer?: { text: string };
                    header?: { text: string; type: "text" };
                    type: "list";
                }
                | {
                    action: { buttons: { reply: ...; type: ... }[] };
                    body: { text: string };
                    footer?: { text: string };
                    header?: { text: string; type: "text" };
                    type: "button";
                };
            };
        }
        | {
            auto?: boolean;
            channel: "whatsapp";
            conversation?: string;
            customer?: string;
            from?: string;
            kbArticles?: string[];
            lang?: string
            | null;
            payload?: { [key: string]: unknown };
            sendAt?: string | null;
            shortcuts?: string[];
            source?: "bulk" | "satisfaction" | "biz-rules";
            to?: string;
        } & {
            app: "whatsapp";
            meta: {
                components?: {
                    body?: { [key: string]: { text?: string; type?: "text" } };
                    buttons?: {
                        index: number;
                        sub_type: "url";
                        [key: string]: number | "url" | { text?: ...; type?: ... };
                    }[];
                    header?: | {
                        text: { [key: string]: { text?: ...; type?: ... } };
                        type: "text";
                    }
                    | { attachment: string; type: "image"
                    | "video"
                    | "document" };
                };
                template: string;
            };
        }
        | {
            attachments?: string[];
            auto?: boolean;
            body?: string;
            channel: "chat";
            conversation?: string;
            customer?: string;
            from?: string;
            kbArticles?: string[];
            lang?: string
            | null;
            payload?: { [key: string]: unknown };
            sendAt?: string | null;
            shortcuts?: string[];
            source?: "bulk" | "satisfaction";
            to?: string;
        }
        | {
            auto?: boolean;
            body?: string;
            channel: "facebook";
            conversation?: string;
            customer?: string;
            from?: string;
            kbArticles?: string[];
            lang?: string
            | null;
            payload?: { [key: string]: unknown };
            sendAt?: string | null;
            shortcuts?: string[];
            source?: "bulk" | "satisfaction";
            to?: string;
        }
        | {
            auto?: boolean;
            body?: string;
            channel: "twitter-tweet";
            conversation?: string;
            customer?: string;
            from?: string;
            kbArticles?: string[];
            lang?: string
            | null;
            payload?: { [key: string]: unknown };
            sendAt?: string;
            shortcuts?: string[];
            source?: "bulk" | "satisfaction";
            to?: string;
        }
        | {
            auto?: boolean;
            body?: string;
            channel: "twitter-dm";
            conversation?: string;
            customer?: string;
            from?: string;
            kbArticles?: string[];
            lang?: string
            | null;
            payload?: { [key: string]: unknown };
            sendAt?: string;
            shortcuts?: string[];
            source?: "bulk" | "satisfaction";
            to?: string;
        }
        | {
            body?: string;
            channel: "note";
            conversation?: string;
            customer?: string;
            kbArticles?: string[];
            lang?: string
            | null;
            payload?: { [key: string]: unknown };
            sendAt?: string | null;
            shortcuts?: string[];
            source?: "bulk";
            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 };
            sendAt?: string | null;
            shortcuts?: string[];
            source?: "bulk" | "satisfaction";
            to?: string;
        }

    Type declaration

    • {
          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 }[];
          kbArticles?: string[];
          lang?: string | null;
          payload?: { [key: string]: unknown };
          replyTo?: string;
          sendAt?: string | null;
          shortcuts?: string[];
          source?: "bulk" | "satisfaction";
          subject?: string;
          template?: string | null;
          to?: { email: string; name?: string }[] | { email: string; name?: string };
      }
      • Optionalapp?: "gmail" | "postmark"
      • Optionalauto?: boolean

        If true, message was automatically generated from a Kustomer workflow or auto-response feature. If set to true, this message will be excluded from reporting metrics. If false, message was created by a manual method.

      • Optionalbcc?: { email: string; name?: string }[]
      • Optionalbody?: string
      • Optionalcc?: { email: string; name?: string }[]
      • channel: "email"

        The communication channel for the message.

      • Optionalconversation?: string
      • Optionalcustomer?: string
      • Optionalfrom?: { email: string; name?: string }
      • Optionalheaders?: { name: string; value?: string }[]
      • OptionalkbArticles?: string[]
      • Optionallang?: string | null

        The language the message is in.

      • Optionalpayload?: { [key: string]: unknown }
      • OptionalreplyTo?: string
      • OptionalsendAt?: string | null

        A timestamp for a future date/time the drafted message to be sent at.

      • Optionalshortcuts?: string[]

        The ID string associated with a shortcut. Shortcuts are pre-defined blocks of text defined in Kustomer. See Get All Shortcuts endpoint view currently available shortcuts or create a shortcut with the Create Shortcut endpoint. to Learn more about shortcuts in the Use workspace shortcuts article.

      • Optionalsource?: "bulk" | "satisfaction"
      • Optionalsubject?: string
      • Optionaltemplate?: string | null
      • Optionalto?: { email: string; name?: string }[] | { email: string; name?: string }
    • {
          app?: "twilio" | "zipwhip";
          auto?: boolean;
          body?: string;
          channel: "sms";
          conversation?: string;
          customer?: string;
          from?: string;
          kbArticles?: string[];
          lang?: string | null;
          payload?: { [key: string]: unknown };
          sendAt?: string | null;
          shortcuts?: string[];
          source?: "bulk" | "satisfaction";
          to?: string;
      }
      • Optionalapp?: "twilio" | "zipwhip"
      • Optionalauto?: boolean
      • Optionalbody?: string
      • channel: "sms"
      • Optionalconversation?: string
      • Optionalcustomer?: string
      • Optionalfrom?: string
      • OptionalkbArticles?: string[]
      • Optionallang?: string | null
      • Optionalpayload?: { [key: string]: unknown }
      • OptionalsendAt?: string | null

        A timestamp for a future date/time the drafted message to be sent at.

      • Optionalshortcuts?: string[]
      • Optionalsource?: "bulk" | "satisfaction"
      • Optionalto?: string
    • {
          auto?: boolean;
          channel: "whatsapp";
          conversation?: string;
          customer?: string;
          from?: string;
          kbArticles?: string[];
          lang?: string | null;
          payload?: { [key: string]: unknown };
          sendAt?: string | null;
          shortcuts?: string[];
          source?: "bulk" | "satisfaction" | "biz-rules";
          to?: string;
      } & { app: "twilio_whatsapp"
      | "messagebird"
      | "whatsapp"; body: string }
      • Optionalauto?: boolean

        If true, message was automatically generated from a Kustomer workflow or auto-response feature. If set to true, this message will be excluded from reporting metrics. If false, message was created by a manual method.

      • channel: "whatsapp"
      • Optionalconversation?: string
      • Optionalcustomer?: string
      • Optionalfrom?: string
      • OptionalkbArticles?: string[]
      • Optionallang?: string | null
      • Optionalpayload?: { [key: string]: unknown }
      • OptionalsendAt?: string | null
      • Optionalshortcuts?: string[]
      • Optionalsource?: "bulk" | "satisfaction" | "biz-rules"
      • Optionalto?: string
      • app: "twilio_whatsapp" | "messagebird" | "whatsapp"
      • body: string

        Required if the message doesn't have any attachments. If the message has an image or video attachment, this field is optional and will be used as the caption for the attached media. If the attachment is any other type, this field is ignored.

    • {
          auto?: boolean;
          channel: "whatsapp";
          conversation?: string;
          customer?: string;
          from?: string;
          kbArticles?: string[];
          lang?: string | null;
          payload?: { [key: string]: unknown };
          sendAt?: string | null;
          shortcuts?: string[];
          source?: "bulk" | "satisfaction" | "biz-rules";
          to?: string;
      } & {
          app: "whatsapp";
          meta: {
              interactive: | {
                  action: { button: string; sections: { rows: ...; title?: ... }[] };
                  body: { text: string };
                  footer?: { text: string };
                  header?: { text: string; type: "text" };
                  type: "list";
              }
              | {
                  action: { buttons: { reply: ...; type: ... }[] };
                  body: { text: string };
                  footer?: { text: string };
                  header?: { text: string; type: "text" };
                  type: "button";
              };
          };
      }
      • Optionalauto?: boolean

        If true, message was automatically generated from a Kustomer workflow or auto-response feature. If set to true, this message will be excluded from reporting metrics. If false, message was created by a manual method.

      • channel: "whatsapp"
      • Optionalconversation?: string
      • Optionalcustomer?: string
      • Optionalfrom?: string
      • OptionalkbArticles?: string[]
      • Optionallang?: string | null
      • Optionalpayload?: { [key: string]: unknown }
      • OptionalsendAt?: string | null
      • Optionalshortcuts?: string[]
      • Optionalsource?: "bulk" | "satisfaction" | "biz-rules"
      • Optionalto?: string
      • app: "whatsapp"

        WhatsApp interactive messages are only officially supported for Kustomer native WhatsApp for now.

      • meta: {
            interactive:
                | {
                    action: { button: string; sections: { rows: ...; title?: ... }[] };
                    body: { text: string };
                    footer?: { text: string };
                    header?: { text: string; type: "text" };
                    type: "list";
                }
                | {
                    action: { buttons: { reply: ...; type: ... }[] };
                    body: { text: string };
                    footer?: { text: string };
                    header?: { text: string; type: "text" };
                    type: "button";
                };
        }
    • {
          auto?: boolean;
          channel: "whatsapp";
          conversation?: string;
          customer?: string;
          from?: string;
          kbArticles?: string[];
          lang?: string | null;
          payload?: { [key: string]: unknown };
          sendAt?: string | null;
          shortcuts?: string[];
          source?: "bulk" | "satisfaction" | "biz-rules";
          to?: string;
      } & {
          app: "whatsapp";
          meta: {
              components?: {
                  body?: { [key: string]: { text?: string; type?: "text" } };
                  buttons?: {
                      index: number;
                      sub_type: "url";
                      [key: string]: number | "url" | { text?: ...; type?: ... };
                  }[];
                  header?: | {
                      text: { [key: string]: { text?: ...; type?: ... } };
                      type: "text";
                  }
                  | { attachment: string; type: "image"
                  | "video"
                  | "document" };
              };
              template: string;
          };
      }
      • Optionalauto?: boolean

        If true, message was automatically generated from a Kustomer workflow or auto-response feature. If set to true, this message will be excluded from reporting metrics. If false, message was created by a manual method.

      • channel: "whatsapp"
      • Optionalconversation?: string
      • Optionalcustomer?: string
      • Optionalfrom?: string
      • OptionalkbArticles?: string[]
      • Optionallang?: string | null
      • Optionalpayload?: { [key: string]: unknown }
      • OptionalsendAt?: string | null
      • Optionalshortcuts?: string[]
      • Optionalsource?: "bulk" | "satisfaction" | "biz-rules"
      • Optionalto?: string
      • app: "whatsapp"

        WhatsApp templates are only officially supported for Kustomer native WhatsApp for now.

      • meta: {
            components?: {
                body?: { [key: string]: { text?: string; type?: "text" } };
                buttons?: {
                    index: number;
                    sub_type: "url";
                    [key: string]: number | "url" | { text?: ...; type?: ... };
                }[];
                header?: | {
                    text: { [key: string]: { text?: ...; type?: ... } };
                    type: "text";
                }
                | { attachment: string; type: "image"
                | "video"
                | "document" };
            };
            template: string;
        }
        • Optionalcomponents?: {
              body?: { [key: string]: { text?: string; type?: "text" } };
              buttons?: {
                  index: number;
                  sub_type: "url";
                  [key: string]: number | "url" | { text?: ...; type?: ... };
              }[];
              header?: | {
                  text: { [key: string]: { text?: ...; type?: ... } };
                  type: "text";
              }
              | { attachment: string; type: "image"
              | "video"
              | "document" };
          }
          • Optionalbody?: { [key: string]: { text?: string; type?: "text" } }
          • Optionalbuttons?: {
                index: number;
                sub_type: "url";
                [key: string]: number | "url" | { text?: ...; type?: ... };
            }[]

            We currently only support parameterizing one button. The index and sub_type fields should be the same for all entries in this array, and the numbered parameters provided will only be applied to the button indexed by the index value provided.

          • Optionalheader?:
                | { text: { [key: string]: { text?: ...; type?: ... } }; type: "text" }
                | { attachment: string; type: "image" | "video" | "document" }
        • template: string

          Template IDs can be found at /v1/whatsapp/accounts/{accountId}/templates

    • {
          attachments?: string[];
          auto?: boolean;
          body?: string;
          channel: "chat";
          conversation?: string;
          customer?: string;
          from?: string;
          kbArticles?: string[];
          lang?: string | null;
          payload?: { [key: string]: unknown };
          sendAt?: string | null;
          shortcuts?: string[];
          source?: "bulk" | "satisfaction";
          to?: string;
      }
      • Optionalattachments?: string[]
      • Optionalauto?: boolean
      • Optionalbody?: string
      • channel: "chat"
      • Optionalconversation?: string
      • Optionalcustomer?: string
      • Optionalfrom?: string
      • OptionalkbArticles?: string[]
      • Optionallang?: string | null
      • Optionalpayload?: { [key: string]: unknown }
      • OptionalsendAt?: string | null

        A timestamp for a future date/time the drafted message to be sent at.

      • Optionalshortcuts?: string[]
      • Optionalsource?: "bulk" | "satisfaction"
      • Optionalto?: string
    • {
          auto?: boolean;
          body?: string;
          channel: "facebook";
          conversation?: string;
          customer?: string;
          from?: string;
          kbArticles?: string[];
          lang?: string | null;
          payload?: { [key: string]: unknown };
          sendAt?: string | null;
          shortcuts?: string[];
          source?: "bulk" | "satisfaction";
          to?: string;
      }
      • Optionalauto?: boolean
      • Optionalbody?: string
      • channel: "facebook"
      • Optionalconversation?: string
      • Optionalcustomer?: string
      • Optionalfrom?: string
      • OptionalkbArticles?: string[]
      • Optionallang?: string | null
      • Optionalpayload?: { [key: string]: unknown }
      • OptionalsendAt?: string | null

        A timestamp for a future date/time the drafted message to be sent at.

      • Optionalshortcuts?: string[]
      • Optionalsource?: "bulk" | "satisfaction"
      • Optionalto?: string
    • {
          auto?: boolean;
          body?: string;
          channel: "twitter-tweet";
          conversation?: string;
          customer?: string;
          from?: string;
          kbArticles?: string[];
          lang?: string | null;
          payload?: { [key: string]: unknown };
          sendAt?: string;
          shortcuts?: string[];
          source?: "bulk" | "satisfaction";
          to?: string;
      }
      • Optionalauto?: boolean
      • Optionalbody?: string
      • channel: "twitter-tweet"
      • Optionalconversation?: string
      • Optionalcustomer?: string
      • Optionalfrom?: string
      • OptionalkbArticles?: string[]
      • Optionallang?: string | null
      • Optionalpayload?: { [key: string]: unknown }
      • OptionalsendAt?: string

        A timestamp for a future date/time the drafted message to be sent at.

      • Optionalshortcuts?: string[]
      • Optionalsource?: "bulk" | "satisfaction"
      • Optionalto?: string
    • {
          auto?: boolean;
          body?: string;
          channel: "twitter-dm";
          conversation?: string;
          customer?: string;
          from?: string;
          kbArticles?: string[];
          lang?: string | null;
          payload?: { [key: string]: unknown };
          sendAt?: string;
          shortcuts?: string[];
          source?: "bulk" | "satisfaction";
          to?: string;
      }
      • Optionalauto?: boolean
      • Optionalbody?: string
      • channel: "twitter-dm"
      • Optionalconversation?: string
      • Optionalcustomer?: string
      • Optionalfrom?: string
      • OptionalkbArticles?: string[]
      • Optionallang?: string | null
      • Optionalpayload?: { [key: string]: unknown }
      • OptionalsendAt?: string

        A timestamp for a future date/time the drafted message to be sent at.

      • Optionalshortcuts?: string[]
      • Optionalsource?: "bulk" | "satisfaction"
      • Optionalto?: string
    • {
          body?: string;
          channel: "note";
          conversation?: string;
          customer?: string;
          kbArticles?: string[];
          lang?: string | null;
          payload?: { [key: string]: unknown };
          sendAt?: string | null;
          shortcuts?: string[];
          source?: "bulk";
          userMentions?: { team?: string; user?: string }[];
      }
      • Optionalbody?: string
      • channel: "note"
      • Optionalconversation?: string
      • Optionalcustomer?: string
      • OptionalkbArticles?: string[]
      • Optionallang?: string | null
      • Optionalpayload?: { [key: string]: unknown }
      • OptionalsendAt?: string | null

        A timestamp for a future date/time the drafted message to be sent at.

      • Optionalshortcuts?: string[]
      • Optionalsource?: "bulk"
      • OptionaluserMentions?: { 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 };
          sendAt?: string | null;
          shortcuts?: string[];
          source?: "bulk" | "satisfaction";
          to?: string;
      }
      • Optionalauto?: boolean
      • Optionalbody?: string
      • channel: "instagram"
      • Optionalconversation?: string
      • Optionalcustomer?: string
      • Optionalfrom?: string
      • OptionalkbArticles?: string[]
      • Optionallang?: string | null
      • Optionalpayload?: { [key: string]: unknown }
      • OptionalsendAt?: string | null

        A timestamp for a future date/time the drafted message to be sent at.

      • Optionalshortcuts?: string[]
      • Optionalsource?: "bulk" | "satisfaction"
      • Optionalto?: string
    path: { id: string }

    Type declaration

    • id: string

      Unique ID of the customer.

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

    Settings

    Member Visibility

    On This Page

    Properties