SoftSolzSoftSolz
Sign up
HomeAPI GuideAPI ReferenceWidget Tester
site builder

Rename a website or change its description or language.

Only the given keys change. Changing language does not rewrite the pages; update the html lang attributes and copy with files/apply. 409 STALE_VERSION when expected_updated_at is stale.

PATCHhttps://app.softsolz.uk/api/v1/services/site-builder/projects/{id}

Recent Requests

Log in to see full request history
TimeStatusUser Agent
Make a request to see history.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Body Params

namestring

New name.

descriptionstring

New description.

languagestring

BCP 47 language tag the site is written in (en, en-GB, fr, pt-BR). Defaults to the workspace locale. It is written as the html lang attribute of every page.

expected_updated_atstring

Optimistic guard: the updated_at you last read.

Response

Response Body

idintegerWebsite id. Use it as {id} in every project call.
namestringWebsite name shown in the dashboard.
slugstringURL-safe name, unique per workspace.
site_addressstring | nullThe subdomain label the site publishes under.
descriptionstring | nullWhat the website is for, as the person described it.
languagestringBCP 47 language tag of the site copy, also written as the html lang attribute.
statusstringPublish state.
live_urlstring | nullPublic URL once published.
published_atstring | nullWhen the site was last published.
created_atstringCreation timestamp.
updated_atstringLast change to the project record. Round-trip as expected_updated_at on PATCH.
preview_urlstringAbsolute signed preview URL for the home page (valid about 6 hours).
logo_pathstring | nullPath of the uploaded logo under assets/.
starter_idstring | nullStarter template the site began from.
has_unpublished_changesbooleantrue when files changed since the last publish.
file_countinteger | nullNumber of files (list view only).
verified_domainsinteger | nullVerified custom domains (list view only).
memorystring | nullNotes about the business and design decisions kept with the site.
design_systemobject | nullSummary of the design system (style, colors, typography, radius, shadow, spacing) or null.
content_versionstring | nullOpaque version of the site files. Send it as expected_version on files/apply to refuse a write over a newer change.
last_edited_viastring | nullWho last changed the files: dashboard, chat, api or connected_app.
last_edited_labelstring | nullThe app or key name behind the last change.
domainsarray of objectsCustom domains (single-project view only).

Request

import { SoftSolz } from '@softsolz/sdk';


const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });


const result = await client.siteBuilder.updateProject('<id>', {});
console.log(result);

Credentials

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": {
    "id": 0,
    "name": "string",
    "slug": "string",
    "site_address": "string",
    "description": "string",
    "language": "string",
    "status": "string",
    "live_url": "string",
    "published_at": "string",
    "created_at": "string",
    "updated_at": "string",
    "preview_url": "string",
    "logo_path": "string",
    "starter_id": "string",
    "has_unpublished_changes": true,
    "file_count": 0,
    "verified_domains": 0,
    "memory": "string",
    "design_system": "string",
    "content_version": "string",
    "last_edited_via": "string",
    "last_edited_label": "string",
    "domains": []
  }
}