Skip to main content
PATCH
/
workspaces
/
{id}
Partially update a workspace
curl --request PATCH \
  --url https://api.firma.dev/functions/v1/signing-request-api/workspaces/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Workspace Name"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "protected": true,
  "api_key": "<string>",
  "date_created": "2023-11-07T05:31:56Z",
  "date_changed": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Path Parameters

​
id
string<uuid>
required

Workspace ID

Body

application/json
​
name
string

Workspace name

Maximum string length: 255

Response

Workspace updated successfully

​
id
string<uuid>

Unique identifier for the workspace

​
name
string

Workspace name

Maximum string length: 255
​
protected
boolean

Protected workspaces cannot be deleted

​
api_key
string | null

Unique API key for this workspace. Used for authenticating API requests scoped to this workspace.

​
date_created
string<date-time>

Workspace creation timestamp

​
date_changed
string<date-time>

Workspace last update timestamp