PApandadoc
User and Workspace management

[Beta] Update Workspace

Changed on

Update a workspace's name and branding.

  • You need to be an Org Admin to update a workspace.
patch/public/beta/workspaces/{workspace_id}

Request

Path parameters

workspace_idstring required

Workspace id.

Request body

namestring

A new name for the workspace.

icon_urlstring uri nullable

Workspace icon displayed in the application; not visible to your customers. Icon should have square proportions. The URL must be publicly reachable over HTTPS. Supported formats: JPEG, PNG, GIF, WEBP. Max size: 5 MB.

Example request

{
  "name": "Renamed workspace",
  "icon_url": "https://cdn.example.com/icons/workspace.png",
  "branding": {
    "logo_url": "https://cdn.example.com/logos/workspace.png",
    "accent_color": "#248567"
  }
}

Response

OK

idstring

Workspace id.

namestring

Current workspace name.

Example response

{
  "id": "iMymdDd9XFD3HyxP5VD67Q",
  "name": "Renamed workspace",
  "branding": {
    "logo_url": "https://cdn.example.com/logos/workspace.png",
    "accent_color": "#248567"
  }
}

Changes