Skip to content
TriedDocs
Account

Update workspace

Rename the workspace, set its account-level webhook URL or change its concurrency limit.

PATCHhttps://api.tried.com.au/workspace

Changes the workspace name, the account-level webhook URL or the concurrency limit. Send only the fields you want to change. Admin only.

Request#

Field Type Required Description
name string No 1 to 80 characters.
webhook_url string or null No A valid URL. Send null to clear it.
concurrency_limit integer No 1 to 1000.

Example request#

curl -X PATCH https://api.tried.com.au/workspace \
  -H "Authorization: Bearer $TRIED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Harbour Dental",
    "webhook_url": "https://hooks.harbourdental.com.au/tried"
  }'
const res = await fetch("https://api.tried.com.au/workspace", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.TRIED_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Harbour Dental",
    "webhook_url": "https://hooks.harbourdental.com.au/tried"
  }),
});
const workspace = await res.json();
import os, requests

res = requests.patch(
    "https://api.tried.com.au/workspace",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
    json={
        "name": "Harbour Dental",
        "webhook_url": "https://hooks.harbourdental.com.au/tried",
    },
)
workspace = res.json()

Response#

200 OK

{
  "workspace_id": "ws_3f9a1c7e5b2d4086a1c9e7f2",
  "name": "Harbour Dental",
  "webhook_url": "https://hooks.harbourdental.com.au/tried",
  "concurrency_limit": 20,
  "created_timestamp": 1758240000000
}

Returns the updated workspace. The fields are the same as Get workspace.

Errors#

Status When
400 Validation failed, for example webhook_url: Invalid url or concurrency_limit: Number must be less than or equal to 1000.
401 Missing or invalid API key.
403 The key's IP allowlist or scopes reject the request. This route needs the admin scope. A dashboard user without the right role gets Requires role: admin. API keys act as admin.
429 Rate limit exceeded. See Rate limits.

See Errors for the body format.

To test the webhook URL after you set it, send a test event from the Webhooks settings page. See Webhooks.