kustomer-client
    Preparing search index...

    Function createAttachment

    • Create attachment Creates a new attachment document. Includes a temporary upload policy for uploading the file with a POST request.

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

      Legacy Role Equivalent Permission Set Role
      org.user.note.write org.permission.note.create
      org.user.message.write org.permission.message.create

      You can upload attachments by sending a multi-part POST request to the URL found in the response object's meta.upload.url property.

      The request must be accompanied by the key/value pairs found in meta.upload.fields as standard form keys. The file should be included as the last key under the name "file".

      Type Parameters

      • ThrowOnError extends boolean = true

      Parameters

      Returns RequestResult<
          {
              data: {
                  attributes: {
                      contentLength: number;
                      contentType: string;
                      name: string;
                      redacted: boolean;
                      uploaded: boolean;
                  };
                  id: string;
                  links: { related: string; self: string };
                  relationships: {
                      org: { data: { id: string; type: string }; links: { self: string } };
                  };
                  type: string;
              };
              meta: {
                  upload: {
                      fields: {
                          acl: string;
                          bucket: string;
                          "Content-Type": string;
                          key: string;
                          Policy: string;
                          "X-Amz-Algorithm": string;
                          "X-Amz-Credential": string;
                          "X-Amz-Date": string;
                          "X-Amz-Meta-Attachment-Id": string;
                          "X-Amz-Signature": string;
                      };
                      url: string;
                  };
              };
          },
          unknown,
          ThrowOnError,
      >

    Settings

    Member Visibility

    On This Page

    Uploading attachments