Formspark Octri Preview
PATCH/workspaces/{workspaceId}

Update a workspace

Updates the name of an existing workspace for the authenticated user. Supply the workspaceId path parameter and a name between 1 and 128 characters; fields not included in the request are not described by this schema.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
workspaceIdstringrequired
The unique identifier of the workspace to update. Must contain at least one character.

Workspace update details; name is required.

namestringrequired
The workspace's new name. Must contain between 1 and 128 characters.

7 status codes
200Returns the updated workspace, including its identifier, name, plan, submissions quota, and creation and update timestamps.
createdAtstringrequired
idstringrequired
namestringrequired
planstringrequired
Allowed:FREEBUNDLE_50000DEALIFY
submissionsQuotanumberrequired
updatedAtstringrequired
400Returned when the request is malformed or fails validation.
codestringrequired
detailstringrequired
statusnumberrequired
titlestringrequired
typestringrequired
401Returned when the token is missing, malformed, revoked, or expired.
codestringrequired
detailstringrequired
statusnumberrequired
titlestringrequired
typestringrequired
403Returned when the token lacks the required scope, the workspace is not upgraded, or a limit was reached.
codestringrequired
detailstringrequired
statusnumberrequired
titlestringrequired
typestringrequired
404Returned when the resource does not exist.
codestringrequired
detailstringrequired
statusnumberrequired
titlestringrequired
typestringrequired
429Returned when the caller is rate limited and should retry later.
codestringrequired
detailstringrequired
statusnumberrequired
titlestringrequired
typestringrequired
500Returned when a server-side error occurs.
codestringrequired
detailstringrequired
statusnumberrequired
titlestringrequired
typestringrequired

Error handling

A 400 is returned when the request is malformed or fails validation. A 401 is returned when the token is missing, malformed, revoked, or expired, and a 403 is returned when the token lacks the required scope, the workspace is not upgraded, or a limit was reached. A 404 indicates a resource does not exist, a 429 means the caller is rate limited, and a 500 indicates a server-side failure. The workspaceId path parameter must contain at least one character, and name is required and must contain between 1 and 128 characters.