Create an upload URL

Get a pre-signed URL to upload one file. The URL accepts a single

PUT
and expires after 1 hour.

Endpoint

POST
/s3-url-signing

Body

NameTypeRequiredDescription
typestringYesUpload type, see Upload types.
filenamestringYesOriginal file name.
contentTypestringNoMIME type. Default application/octet-stream.
record IDintegerDepends on typee.g. conversation_id for conversation-file, product_id for product-media.

Unknown fields are rejected with 400 Bad Request.

Request

Response

json
FieldDescription
signedUrlURL to PUT the file to.
s3PathFull s3://bucket/key path. Save it where the target resource asks for s3_path.
s3PathWithoutBucketStorage key. Save it where the target resource asks for s3_key.
headersHeaders to send with the upload.

Upload the file

Errors

StatusWhen
400 Bad Requesttype or filename missing, an unknown field, or the record ID the type needs is missing or not found.

Report an issue with this documentation

Please log in to report issues with our documentation.