kustomer-client
    Preparing search index...

    Function getDraftAttachment

    • Get draft attachment Retrieves a draft attachment.

      Any one of the following roles is required for this endpoint:

      Legacy Role Equivalent Permission Set Role
      org.user.attachment.read org.permission.attachment.read

      When you request the resource, the response will include a related URL in the links section. You can use this URL to download the attachment file. This URL is a Pre-Signed URL from S3 and provides access for a limited duration to download a file.

      Type Parameters

      • ThrowOnError extends boolean = true

      Parameters

      Returns RequestResult<
          {
              data: {
                  attributes: {
                      contentLength: number;
                      contentType: string;
                      name: string;
                  };
                  id: string;
                  links: { related: string; self: string };
                  relationships: {
                      draft: {
                          data: { id: string; type: string };
                          links: { self: string };
                      };
                      org: { data: { id: string; type: string }; links: { self: string } };
                  };
                  type: string;
              };
          },
          unknown,
          ThrowOnError,
      >

    Settings

    Member Visibility

    On This Page

    Pre-signed URL