Skip to content

Sync Website Pages

POST
/website-editor/sync

Pull pages from a hosted site project into Studio. FREE.

Each page’s HTML is tagged with stable element ids and stored; a page that already exists (matched by URL, then by path) is OVERWRITTEN with the live HTML, so unpublished edits to it are replaced. Omit paths for every page.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Pull pages from a hosted site project.

object
paths
Any of:
Array<string>
project_name
required

From GET /website-editor/projects.

string

Responses

200

Successful Response

object
data
required

One Studio object, open-shaped. See the module docstring.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string