kustomer-client
    Preparing search index...

    Type Alias UpdateDraftForwardData

    type UpdateDraftForwardData = {
        body?: {
            attachments?: {
                contentLength: number;
                contentType: string;
                id: string;
                name: string;
            }[];
            body?: string;
            from?: { email: string; name?: string };
            lang?: string | null;
            payload?: { [key: string]: unknown };
            replyTo?: string;
            sendAt?: string;
            status?: "draft" | "sent" | "failed";
            subject?: string;
            template?: string | null;
            to?: { email: string; name?: string }[];
        };
        path: { id: string };
        query?: never;
        url: "/forwards/{id}";
    }
    Index

    Properties

    body? path query? url

    Properties

    Optionalbody

    body?: {
        attachments?: {
            contentLength: number;
            contentType: string;
            id: string;
            name: string;
        }[];
        body?: string;
        from?: { email: string; name?: string };
        lang?: string | null;
        payload?: { [key: string]: unknown };
        replyTo?: string;
        sendAt?: string;
        status?: "draft" | "sent" | "failed";
        subject?: string;
        template?: string | null;
        to?: { email: string; name?: string }[];
    }

    Request body details

    Name Detail
    body The message body included with the forwarded conversation.
    from The email address sending the forward.
    lang Describes the language of the object's contents
    sendAt A date in ISO format. Including this property will schedule the forward to be delivered.
    status The status of the forward. A draft status indicates the forward is not scheduled for delivery and still editable. A scheduled status indicates the forward is scheduled for delivery by an email app (postmark or gmail). A draft will be update to a failed or sent status after a delivery attempt.
    subject The subject of the forwarded conversation.
    template The ID of a template that should be used for the forward.
    to The destination email address of the forward. This an array that can accept more than one email recipient.
    attachments The attachments to be sent along the forward. They must exist in S3
    • If you update the sendAt property to a valid timestamp, the forward will be scheduled to be sent and updated to a "scheduled" status.
    • If you ommit the sendAt property, the draft status will remain unchanged.

    Type declaration

    • Optionalattachments?: { contentLength: number; contentType: string; id: string; name: string }[]
    • Optionalbody?: string
    • Optionalfrom?: { email: string; name?: string }
    • Optionallang?: string | null
    • Optionalpayload?: { [key: string]: unknown }
    • OptionalreplyTo?: string
    • OptionalsendAt?: string

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

    • Optionalstatus?: "draft" | "sent" | "failed"
    • Optionalsubject?: string
    • Optionaltemplate?: string | null
    • Optionalto?: { email: string; name?: string }[]
    path: { id: string }

    Type declaration

    • id: string

      Unique draft forward ID.

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

    Settings

    Member Visibility

    On This Page

    Properties