Assign and unassign workspaces

POST

/governance-groups/:groupId/bulk-workspaces

Assigns workspaces to and unassigns workspaces from a governance group. On success, this returns an empty object.

Note:

Postman-managed governance groups (type: system) are read-only through this API. Bulk workspace assignments against a system group return an HTTP 403 Forbidden response.
If any workspace in the batch can’t be applied, no changes are made and the entire request fails with an HTTP 409 Conflict response.

Assigns workspaces to and unassigns workspaces from a governance group. On success, this returns an empty object. **Note:** - Postman-managed governance groups (`type: system`) are read-only through this API. Bulk workspace assignments against a system group return an HTTP `403 Forbidden` response. - If any workspace in the batch can't be applied, no changes are made and the entire request fails with an HTTP `409 Conflict` response.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

groupIdstringRequired

The governance group's ID.

Request

This endpoint expects an object.

createlist of stringsOptional

The IDs of the workspaces to assign to the group.

deletelist of stringsOptional

The IDs of the workspaces to unassign from the group.

Response

Successful Response

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error