Update workspace

PATCH

/api/v1/workspaces/{id}

const url = 'https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"example","auto_join":true}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "auto_join": true }'

Updates a single workspace by ID.

Authorizations

OAuth2
workspaces:write

Parameters

Path Parameters

required

integer

Workspace ID

Request Body

application/json

object

name

string

auto_join

Whether new users in the organization are automatically added to this workspace.

boolean

Example

true

Responses

200

Successful

application/json

object

required

integer

name

required

string

auto_join

required

boolean

created_at

required

string format: date-time

Example

{
  "id": 12345,
  "name": "Default workspace",
  "auto_join": true,
  "created_at": "2023-08-23T10:30:00.000Z"
}

401

Unauthorized

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}

403

Forbidden

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}

404

Not Found

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}

422

Unprocessable Entity

application/json

object

message

required

string

errors

required

object

key

additional properties

Array<string>

Example

{
  "errors": {
    "username": [
      "Username is required.",
      "Username must be unique."
    ],
    "email": [
      "Invalid email format."
    ]
  }
}