generateAttachmentUploadUrl( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Generates an upload URL for uploading a file as an attachment to a specified contact.

To learn how to use the generated upload URL in the response to upload an attachment file, see the Upload API (SDK | REST).

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Contact Attachments
Learn more about app permissions.
Method Declaration
Copy
function generateAttachmentUploadUrl(
  contactId: string,
  fileName: string,
  options: GenerateAttachmentUploadUrlOptions,
): Promise<GenerateAttachmentUploadUrlResponse>;
Method Parameters
contactIdstringRequired

ID of the contact for whom the attachment is being uploaded.

fileNamestringRequired

File name of the attachment including the extension, for example, contact-cv.pdf.

optionsGenerateAttachmentUploadUrlOptionsRequired
Returns
Return Type:Promise<GenerateAttachmentUploadUrlResponse>
JavaScript
import { attachments } from "@wix/crm";

async function generateAttachmentUploadUrl(contactId, fileName, options) {
  const response = await attachments.generateAttachmentUploadUrl(
    contactId,
    fileName,
    options,
  );
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?