Rename a workspace

rename_workspace

Changes the name of a workspace, and optionally its logo.

POST /v1/rename_workspaceScopeworkspaces:writeMakes changes

Only the fields you send change. A name outside 2 to 48 characters is ignored rather than refused, so the old name stays.

A logo is a base64 encoded image of up to 10 MB, and a larger one is refused with The workspace logo must be smaller than 10 MB! An empty string removes the logo that is there.

It needs the Edit workspace permission (workspace.update), which the stock Member role does not hold. See Workspaces.

Request

Call it with a POST to https://api.modulify.ai/v1/rename_workspace, sending the inputs below as a JSON object. The token needs the workspaces:write scope.

It makes changes, so send an Idempotency-Key header whenever you might retry it. A retry with the same key gets the first answer back instead of running again.

curl -X POST https://api.modulify.ai/v1/rename_workspace \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"workspaceId":"WORKSPACE_ID"}'

Over MCP, the same method is the rename_workspace tool.

Inputs

Input	Type	Required	Description
`workspaceId`	string	Yes	The workspace id.
`name`	string	No	The new name, 2 to 48 characters.
`logo`	string	No	A logo image, base64 encoded, up to 10 MB. Send an empty string to remove the one that is there.

Response

Every call answers with the JSON envelope of success, message, data, code and version. data holds the result described above, and on a method that returns a total, count carries it. The response headers carry the call's X-Request-Id and what is left of your per-minute budget in X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. Errors explains every status code a call can answer with.