Skip to navigation

Register an org-level template file and get a presigned upload URL

View as Markdown

Reserves a template file metadata record parented to the caller’s organization (not any space) and returns { id, uploadUrl, uploadExpiresAt, file }. uploadUrl is a secure PUT URL valid for 15 minutes (see uploadExpiresAt, ISO 8601). Two-step upload: PUT the raw bytes to uploadUrl with a Content-Type request header EXACTLY equal to the mimeType you sent, then poll getOrgTemplate until status reaches stored. Request body: fileName (required), mimeType (required), size (bytes, optional). parentType/parentId in the body are ignored: the API forces the parent to this organization. No processing is requested (templates are filled, not parsed). Authorization: org admin (denied → 403).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

Templates are filled, not parsed: no processingKind is sent, so the file settles at stored and is never indexed. parentType / parentId are ignored.

fileNamestringRequired>=1 character
mimeTypestringRequired>=1 character
sizeintegerOptional0-9007199254740991

Response

Template record created, with its presigned upload URL.
idstring
uploadUrlstring

Presigned upload URL, valid 15 minutes. PUT the raw bytes there with a Content-Type header EXACTLY equal to the mimeType sent at create.

uploadExpiresAtdatetime
fileobject