/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Update Organization

Update Organization

Rename a workspace or change its slug.

PATCH/v1/orgs/{orgId}Try it
Session token

Renames a workspace or changes its URL slug.

Note

Requires the admin or owner role and a session JWT. API keys are rejected with 401. A member gets 403 forbidden with details.requiredRole: "admin" — see Role errors. Any plan.

Path Parameters

NameDescription
orgId:stringpathRequired
The organization ID.

Request Body

Send at least one field. Any other key is ignored and not stored.

NameDescription
name:stringbody
Display name, 2–100 characters after trimming.
slug:stringbody
URL slug, 2–50 characters of lowercase letters, digits and -. Must not be used by any other workspace, including deleted ones whose slug hasn't been released.

Response — 200 OK

role is your own role in the workspace. The change is recorded in the audit log as org.updated.

Error Responses

400 Bad Request

Returned when neither field is sent, or a value is out of range. The code is validation_error, with each problem in details.issues.

401 Unauthorized

unauthorized for a missing, invalid or expired token (or an API key); session_revoked when the session has been signed out.

403 Forbidden

Returned when you are a member of the workspace:

json
{
"error": {
"code": "forbidden",
"message": "Only workspace admins can change workspace settings.",
"details": { "requiredRole": "admin", "currentRole": "member", "traceId": "6f1c2a9e-3b7d-4c11-9a0e-2d5f8b4c7e10" }
}
}

403 forbidden without role details ("Not a member of this organization") means you don't belong to the workspace.

404 Not Found

not_found — the workspace doesn't exist or has been deleted.

409 Conflict

slug_taken — another workspace has that slug. details.slug echoes it:

json
{
"error": {
"code": "slug_taken",
"message": "That workspace URL is taken.",
"details": { "slug": "acme-docs", "traceId": "6f1c2a9e-3b7d-4c11-9a0e-2d5f8b4c7e10" }
}
}
Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl -X PATCH https://api.syntext.dev/v1/orgs/3f9c2a1e-6b4d-4e8a-a1c7-5d2e9f0b7c13 \
-H "Authorization: Bearer $SYNTEXT_JWT" \
-H "Content-Type: application/json" \
-d '{ "name": "Acme Docs", "slug": "acme-docs" }'
Responseapplication/json
200OK
{
"data": {
"id": "3f9c2a1e-6b4d-4e8a-a1c7-5d2e9f0b7c13",
"name": "Acme Docs",
"slug": "acme-docs",
"createdAt": "2026-02-10T08:00:00.000Z",
"updatedAt": "2026-11-08T14:20:00.000Z",
"deletedAt": null,
"role": "owner"
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext