PATCH /public/beta/workspaces/{workspace_id}
Update a workspace's name and branding.
- You need to be an Org Admin to update a workspace.
Servers
- https://api.pandadoc.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
workspace_id |
String | Yes |
Workspace id. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | No |
A new name for the workspace. |
icon_url |
String | No |
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. |
branding |
Object | No |
Customer-facing branding shown to recipients on the document signing page and in branded emails and templates. |
branding.accent_color |
String | No |
Accent color as a 6-digit HEX value (with leading |
branding.logo_url |
String | No |
Logo shown to recipients. The URL must be publicly reachable over HTTPS. Supported formats: JPEG, PNG, GIF, WEBP. Max size: 5 MB. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.