zendesk-messaging-client
    Preparing search index...

    Type Alias UploadAttachmentData

    type UploadAttachmentData = {
        body: AttachmentUploadBody;
        path: { appId: string };
        query: { access: string; conversationId?: string; for?: string };
        url: "/v2/apps/{appId}/attachments";
    }
    Index

    Properties

    body path query url

    Properties

    body

    body: AttachmentUploadBody
    path: { appId: string }

    Type declaration

    • appId: string

      Identifies the app.

    query: { access: string; conversationId?: string; for?: string }

    Type declaration

    • access: string

      The access level for the attachment. Currently the only available access level is public. Private is not supported.

    • OptionalconversationId?: string

      Links the attachment getting uploaded to the conversation ID.

    • Optionalfor?: string

      Specifies the intended container for the attachment, to enable automatic attachment deletion (on deletion of associated message, conversation or user). For now, only message is supported. See Attachments for Messages for details.

    url: "/v2/apps/{appId}/attachments"

    Settings

    Member Visibility

    On This Page

    Properties