Documents can be uploaded as Files and attached to Events and ItemSets.
Files can also be used as default templates for Offers and Invoices.
Upload a File
Creates a File based on the provided binary and metadata.
Use multipart/form-data, where the file field contains the binary payload and the orgId and name fields contain the metadata.
Request Body
orgIdstring · uuid · requiredThe id of the
Organizationthat owns thisFile.namestring · requiredThe display name for the uploaded
File.filestring · binary · requiredBinary payload (multipart/form-data
file).
Responses
The newly uploaded File.
fileobject
Update a File
Updates the specified File by setting the values of the fields passed. Any fields not provided will remain unchanged. By design, you cannot change a File's id.
Use multipart/form-data, even when only updating metadata.
path Parameters
fileIdstring · uuid · requiredThe id of the
File.
Request Body
namestringThe display name of the
File.filestring · binaryBinary payload to replace the existing content.
Responses
The updated File.
fileobject