Skip to main content
POST
Upload attachment
Requires a valid authenticated request for the builder. No resource-specific scope is required for upload. Uploads one attachment file into BuildPass-managed attachment storage and returns an attachment reference. Include type=attachment in the multipart body. The type tells BuildPass which storage family to use; attachment is the only externally supported upload type for now. For example, you can use the returned { key, regionId, type } to create a photo by passing it as imageAttachment.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowClient Credentials
Token URL
https://api.buildpass.global/oauth/token

Path Parameters

builderId
string
required

Body

multipart/form-data
file
file
required
type
enum<string>
required
Available options:
attachment

Response

201 - application/json

Attachment uploaded

key
string
required
Example:

"external-uploads/ckbuilder123456789012345678/photo.jpg"

type
enum<string>
required
Available options:
attachment
regionId
string | null
Example:

"au1"

imageUrl
string<uri>
fileName
string
contentType
string
fieldName
string

Present on bulk upload responses.