STstarkbank
Workspace

Update a Workspace

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

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

Path parameters

idstring required

Id of the workspace.

Request body

allowedTaxIdsstring[]

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"]

namestring

Full name that identifies the Workspace. This name will appear when people access the Workspace on our platform, for example. Example: 'Stark Bank Workspace'

picturestring

Binary buffer of the picture. Example: open("path/to/picture.png", "rb").read()

pictureTypestring required

Picture mime type. This parameter will be required if the picture parameter is informed. Example: 'image/png' or 'image/jpeg'

statusstring

You can block or activate a specific Workspace. Example: 'active' or 'blocked'

usernamestring

Simplified name to define the workspace URL. This name must be unique across all Stark Bank Workspaces. Example: 'starkbank-workspace'

Response

Successful operation

object required

Changes

No recorded changes to this operation across all 1 revision of this API.