Workspace

Rename the workspace

PATCHhttps://voxa.abhinavyadav.in/api/v1/workspace

Authorization

A signed-in member with the members.manage permission (Authorization: Bearer session token). API keys can’t do this.

Authorization: Bearermembers.manageworks before activation

Query parameters

timezonestringdefault: "Asia/Kolkata"

IANA time zone for every timestamp in the response (at, date, timestamp and *_at fields), as ISO 8601 with the offset. The X-Timezone header works too; the zone used comes back in the X-Timezone response header. An unknown zone is a 400.

Body application/json

namestringrequired

2 to 100 characters

Response

200Success.

See the 200 example next to the code samples.

401No credentials, or they are invalid or revoked.

detailstring

What went wrong, in plain words.

403Your role (or an API key) lacks the permission.

detailstring

What went wrong, in plain words.

422Validation Error

detailobject[]

Show item attributes

locstring | integer[]

msgstring

typestring

curl --request PATCH \
  --url 'https://voxa.abhinavyadav.in/api/v1/workspace?timezone=Asia/Kolkata' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "City Clinic Pune"
}'

import requests

url = "https://voxa.abhinavyadav.in/api/v1/workspace"
params = {
    "timezone": "Asia/Kolkata",
}
headers = {
    "Authorization": "Bearer <token>",
}
payload = {
    "name": "City Clinic Pune",
}

response = requests.patch(url, params=params, headers=headers, json=payload)
print(response.status_code, response.json())

const response = await fetch("https://voxa.abhinavyadav.in/api/v1/workspace?timezone=Asia/Kolkata", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "City Clinic Pune"
  }),
})
const data = await response.json()
console.log(response.status, data)

Response

{
  "id": "ws_8d2e…",
  "name": "City Clinic Pune",
  "status": "active",
  "credits_paise": 250000,
  "members_count": 3
}

{
  "detail": "sign in required"
}

{
  "detail": "your role cannot do this (members.manage)"
}

{
  "detail": [
    {
      "type": "missing",
      "loc": [
        "body",
        "name"
      ],
      "msg": "Field required",
      "input": {}
    }
  ]
}