Skip to main content
A file belongs to one workspace, and any key that belongs to that workspace can read it. Upload one with POST /files. A brand kit takes a file by its id, as its tile’s logo, its tile’s picture or its email logo. The file’s bytes are copied onto the kit, so the kit keeps its image whatever happens to the file.

​
Attributes

​
string
required
File ID, beginning with file_.
​
string
required
Always file.
​
string
required
What the file is for. brand_kit: an image for a brand kit.
​
string
required
The workspace the file belongs to, a wks_ id.
​
string
required
The name the file was uploaded with. Its extension is replaced when it does not match the image type.
​
string
required
The image type, read from the file’s bytes: image/png, image/jpeg, image/gif, image/webp or image/svg+xml.
​
integer
required
Size in bytes.
​
string
required
A signed URL to download the file, valid for one year. Every read returns a fresh one. An SVG is served as a download, never inline.
​
string
required
When the file was uploaded, in ISO 8601.