Start a file upload for a vendor custom field

Asks for a one-time upload slot for a file you want to store in a vendor's custom field. This endpoint does not take the file — it hands back where to send the bytes, and a session id you then pass to Set a vendor's custom field value. Requires the vendors:write permission.

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Path parameters

vendorIdstringrequired

The vendor to act on. A Snowflake id, sent as a decimal string.

example: 1826110384726355968

customFieldIdstringrequired

The custom field. It must be one defined for vendors.

example: 1825110384726355968

Body

application/json

fileNamestringrequired

The file's name, kept as the stored name. Between 1 and 250 characters.

fileSizeintegerrequired

Size of the file in bytes. At least 1, and at most 104857600 (100 MB) for a custom field file.

contentTypestringrequired

The file's MIME type. Custom field files accept any image/* type and application/pdf. Between 1 and 200 characters.

Response

200 · Where to send the bytes.

sessionIdstringrequired

The upload session. Pass this as referenceFileUploadSessionId once the bytes are up.

endpointstringrequired

The URL to send the file to. It is pre-signed and belongs to the storage provider, not to this API.

methodstringrequired

The HTTP method to use against endpoint, for example PUT or POST.

fieldsobjectrequired

Extra form fields the storage provider needs, as name-to-value pairs. Send them with the file when method is POST; the object is empty when none are needed.

expiresstring · date-timerequired

When the slot stops accepting the file, in the company's timezone and without an offset.

Start a file upload for a vendor custom field

Authorization

Path parameters

Body

Response

200 · Where to send the bytes.

400 · The file name, size or content type is missing or outside the allowed range.

401 · The request carried no valid access token.

403 · The token is not a property manager token, or it lacks the `vendors:write` permission.

404 · No such vendor, or it belongs to another company.