Skip to main content
POST
Sync a photo report
Requires write:photos. Send the complete report’s title, text and image blocks in page. Upload photos using bulk upsert photos, then include the returned attachment IDs in the report. Keep sourceExternalId the same for each report and increase sourceRevision when its content changes. Retry with the same revision and content; outdated or conflicting revisions return 409. Use PATCH to update an existing report and DELETE to archive it. Send a newer revision with POST to restore an archived report.

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
sourceApp
string
required
Required string length: 1 - 80
sourceExternalId
string
required
Required string length: 1 - 220
sourceRevision
integer
required
Required range: 1 <= x <= 2147483647
sourceCreatedAt
string<date-time>
required
Minimum string length: 1
walkthroughDate
string<date-time>
required
Minimum string length: 1
sourceAuthor
object
required
page
object
required

Authoritative snapshot. Maximum 500 blocks across the whole tree and four Page levels including root. Source block IDs are unique among siblings.

mappedAdminUserId
string
Minimum string length: 1
Pattern: ^user_[a-z][a-z0-9]+$

HTTPS or supasite URI with no credentials, query string or fragment.

Required string length: 1 - 1000
projectId
string | null
Minimum string length: 1
Pattern: ^proj_[a-z][a-z0-9]+$

Response

Snapshot committed

status
enum<string>
required
Available options:
synced,
partial
idempotent
boolean
required
photoReportId
string
required
Minimum string length: 1
Pattern: ^phrep_
pageId
string
required
Minimum string length: 1
Pattern: ^page_
sourceRevision
integer
required
Required range: 1 <= x <= 2147483647