---
title: "Update a Workspace"
method: PATCH
path: "/v2/workspace/{id}"
tags: ["Workspace"]
---

# Update a Workspace

`PATCH /v2/workspace/{id}`

## Request

- Base URL: `https://api.starkbank.com`
- URL: `https://api.starkbank.com/v2/workspace/{id}`
- Auth: API key in header `Digital-Signature`

Update a workspace by passing its id and the fields you want to update.

## Path parameters

- `id` string, required

## Request body

- object
  - `allowedTaxIds` string[]: List of tax IDs that will be allowed to send Deposits to this Workspace. If empty, all are allowed. Example: ["012.345.678-90", "20.018.183/0001-80"]
  - `name` string: Full name that identifies the Workspace. This name will appear when people access the Workspace on our platform, for example. Example: 'Stark Bank Workspace'
  - `picture` string: Binary buffer of the picture. Example: open("path/to/picture.png", "rb").read()
  - `pictureType` string, required: Picture mime type. This parameter will be required if the picture parameter is informed. Example: 'image/png' or 'image/jpeg'
  - `status` string: You can block or activate a specific Workspace. Example: 'active' or 'blocked'
  - `username` string: Simplified name to define the workspace URL. This name must be unique across all Stark Bank Workspaces. Example: 'starkbank-workspace'

## Response `200`

Successful operation

- object

## Other responses

- `400`: Client error
- `500`: Server error

---

[API](https://skmtc.dev/starkbank/apis/stark-bank-api.md) - [All operations](https://skmtc.dev/starkbank/apis/stark-bank-api/llms.txt) - [OpenAPI document](https://skmtc.dev/starkbank/apis/stark-bank-api/revisions/aeff5068a5da?raw)
