kustomer-client
    Preparing search index...

    Type Alias UpdateMessageData

    type UpdateMessageData = {
        body?: {
            attachments?: {
                _id: string;
                contentLength: number;
                contentType: string;
                name: string;
                sourceId?: string;
            }[];
            conversation?: string;
            createdAt?: string;
            createdBy?: string;
            custom?: { [key: string]: never };
            error?: {
                code?: string;
                detail?: string;
                links?: { [key: string]: unknown };
                meta?: { [key: string]: unknown };
                source?: { [key: string]: unknown };
                status?: number;
                title?: string;
            };
            errorAt?: string;
            externalId?: string
            | null;
            lang?: string | null;
            meta?: { [key: string]: unknown };
            modifiedAt?: string;
            modifiedBy?: string | null;
            preview?: string | null;
            reactions?: {
                createdAt?: string;
                name: "love";
                subjectId: string;
                subjectType: "customer" | "user";
            }[];
            related?: string;
            sentAt?: string
            | null;
            sentiment?: { confidence: number; polarity: -1 | 0 | 1 };
            size?: number;
            spam?: boolean;
            status?: "sent" | "received" | "error";
            subject?: string | null;
            updatedAt?: string;
        };
        path: { id: string };
        query?: { replace?: boolean };
        url: "/messages/{id}";
    }
    Index

    Properties

    Properties

    body?: {
        attachments?: {
            _id: string;
            contentLength: number;
            contentType: string;
            name: string;
            sourceId?: string;
        }[];
        conversation?: string;
        createdAt?: string;
        createdBy?: string;
        custom?: { [key: string]: never };
        error?: {
            code?: string;
            detail?: string;
            links?: { [key: string]: unknown };
            meta?: { [key: string]: unknown };
            source?: { [key: string]: unknown };
            status?: number;
            title?: string;
        };
        errorAt?: string;
        externalId?: string
        | null;
        lang?: string | null;
        meta?: { [key: string]: unknown };
        modifiedAt?: string;
        modifiedBy?: string | null;
        preview?: string | null;
        reactions?: {
            createdAt?: string;
            name: "love";
            subjectId: string;
            subjectType: "customer" | "user";
        }[];
        related?: string;
        sentAt?: string
        | null;
        sentiment?: { confidence: number; polarity: -1 | 0 | 1 };
        size?: number;
        spam?: boolean;
        status?: "sent" | "received" | "error";
        subject?: string | null;
        updatedAt?: string;
    }
    path: { id: string }

    Type declaration

    • id: string

      Unique message ID.

    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: "/messages/{id}"