Skip to main content
POST
/
builders
/
{builderId}
/
photos
Create photo
curl --request POST \
  --url https://api.buildpass.global/builders/{builderId}/photos \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fileName": "<string>",
  "projectId": "proj_ckproject123456789012345678",
  "folderId": "<string>",
  "imageUrl": "<string>",
  "contentType": "image/jpeg",
  "capturedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "externalSourceId": "<string>"
}
'
{
  "id": "<string>",
  "builderId": "<string>",
  "projectId": "<string>",
  "folderId": "<string>",
  "fileName": "<string>",
  "contentType": "<string>",
  "key": "<string>",
  "fileSize": "<string>",
  "description": "<string>",
  "photoTakenDate": "2023-11-07T05:31:56Z",
  "sortDate": "2023-11-07T05:31:56Z",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "archivedAt": "2023-11-07T05:31:56Z",
  "imageUrl": "<string>"
}
Requires write:photos. Creates a gallery photo record from JSON with an uploaded imageAttachment reference or an approved imageUrl. Upload image bytes first with POST /builders/{builderId}/attachments/upload, then pass the returned { key, regionId, type } as imageAttachment. Approved HTTPS imageUrl imports are supported only for hosts reviewed and enabled by BuildPass. If you want to import photos from your own image URL hosts, please contact BuildPass.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
builderId
string
required

Body

application/json
​
fileName
string
required
​
projectId
string
Example:

"proj_ckproject123456789012345678"

​
folderId
string
​
imageAttachment
object
​
imageUrl
string<uri>

Approved HTTPS URL to import. To import photos from your own image URL hosts, contact BuildPass so those hosts can be reviewed and enabled.

​
contentType
string
default:image/jpeg
​
capturedAt
string<date-time>
​
description
string
​
externalSourceId
string

Response

201 - application/json

Photo created

​
id
string
​
builderId
string | null
​
projectId
string | null
​
folderId
string | null
​
fileName
string
​
contentType
string
​
key
string
​
fileSize
string
​
description
string | null
​
photoTakenDate
string<date-time> | null
​
sortDate
string<date-time> | null
​
metadata
object
​
createdAt
string<date-time>
​
updatedAt
string<date-time>
​
archivedAt
string<date-time> | null
​
imageUrl
string<uri> | null

Short-lived signed URL for downloading the photo image.