{}{
"object": "preview_url",
"previewUrl": {
"id": "clz9d8f9g0016qaz3wsx4edc",
"name": "Local",
"url": "http://localhost:3456",
"sandboxId": null,
"isDefault": false,
"projectId": "clz8k2m4n0001qwer7tyu8iop",
"createdAt": "2026-10-20T10:15:00.000Z",
"updatedAt": "2026-10-20T10:15:00.000Z"
}
}{
"object": "error",
"code": "UNAUTHORIZED",
"message": "<string>",
"status": 123,
"details": "<unknown>"
}{
"object": "error",
"code": "UNAUTHORIZED",
"message": "<string>",
"status": 123,
"details": "<unknown>"
}{
"object": "error",
"code": "UNAUTHORIZED",
"message": "<string>",
"status": 123,
"details": "<unknown>"
}{
"object": "error",
"code": "UNAUTHORIZED",
"message": "<string>",
"status": 123,
"details": "<unknown>"
}{
"object": "error",
"code": "CONFLICT",
"message": "A preview URL with this address already exists",
"status": 409
}Create, update or delete a preview URL
One endpoint for preview URL writes, selected by op:
create(name,url, optionalisDefault): returns 201{ object: "preview_url", previewUrl }. 409 when the project already has a preview with this URL. SettingisDefault: trueunsets the previous default.update(id, optionalname,url,isDefault): returns 200{ object: "preview_url", previewUrl }. 409 when another preview of this project already has the new URL.delete(id): returns 200{ object: "preview_url_deleted", id }. Permanent.
name is at most 191 characters and url at most 2048. Ids are resolved through this project; an id from another project returns 404.
Required scope: project:manage
{}{
"object": "preview_url",
"previewUrl": {
"id": "clz9d8f9g0016qaz3wsx4edc",
"name": "Local",
"url": "http://localhost:3456",
"sandboxId": null,
"isDefault": false,
"projectId": "clz8k2m4n0001qwer7tyu8iop",
"createdAt": "2026-10-20T10:15:00.000Z",
"updatedAt": "2026-10-20T10:15:00.000Z"
}
}{
"object": "error",
"code": "UNAUTHORIZED",
"message": "<string>",
"status": 123,
"details": "<unknown>"
}{
"object": "error",
"code": "UNAUTHORIZED",
"message": "<string>",
"status": 123,
"details": "<unknown>"
}{
"object": "error",
"code": "UNAUTHORIZED",
"message": "<string>",
"status": 123,
"details": "<unknown>"
}{
"object": "error",
"code": "UNAUTHORIZED",
"message": "<string>",
"status": 123,
"details": "<unknown>"
}{
"object": "error",
"code": "CONFLICT",
"message": "A preview URL with this address already exists",
"status": 409
}Authorizations
Bearer authentication: a shop API key (WEAVERSE_API_KEY), a scoped API key, a delegated MCP OAuth token, or (translation-unit routes only) a project-bound translation agent token. Scopes: content:read — Read projects, pages, theme settings, versions, drafts and translation units. content:write — Save drafts and make non-destructive edits (page items, metadata, SEO, assignments, languages, glossary). Never publishes or deletes. content:publish — Publish drafts, schedule/reschedule/cancel publications, restore versions, publish global sections. content:delete — Delete pages, global sections, languages, static keys, override reverts; required with project:manage for project deletion. project:manage — Create/copy/delete projects, settings, variants, hierarchy, backups, restore-as-new, previews, hostname policy. translations:read — Read translation units only (no general content access). translations:write — Apply translation units only; never mutates page content. A legacy unscoped API key keeps read/write/translation baseline access and every pre-scope endpoint, but never gains publish/delete/project-manage implicitly.
Path Parameters
Body
Response
Operation result
The response is of type object.
Was this page helpful?