---
title: "Update a workspace"
method: PUT
path: "/v3/workspace"
tags: ["Workspaces"]
---

# Update a workspace

`PUT /v3/workspace`

## Request

- Base URL: `https://api.carbonvoice.app`
- URL: `https://api.carbonvoice.app/v3/workspace`
- Auth: one of:
  - API key in header `pxtoken`
  - OAuth 2 (implicit, authorization URL `https://api.carbonvoice.app/oauth/authorize`)

## Request body

- UpsertWorkspaceDto
  - `workspace_guid` string, required
  - `name` string
  - `description` string, nullable
  - `vanity_name` string, nullable
  - `invitation_mode` 'anyone' | 'admin-only' | 'any-member'
  - `who_can_change_conversation_retention` Role[], nullable
  - `who_can_mark_messages_as_preserved` Role[], nullable
  - `domain_referral_mode` 'do-not-inform' | 'automatic' | 'request' | 'share-instructions'
  - `domain_referral_message` string, nullable
  - `domain_referral_title` string, nullable

## Response `200`

- WorkspaceV2
  - `_id` string, required
  - `vanity_name` string, nullable
  - `name` string, required
  - `description` string, nullable
  - `image_url` string, nullable
  - `type` 'standard' | 'webcontact' | 'personallink'
  - `created_at` string, date-time, required
  - `last_updated_at` string, date-time, required
  - `plan_type` 'standard' | 'business-premium' | 'team-premium' | 'personal-premium' | 'free'
  - `users` WorkspaceUser[], required
    - `user_id` string, required
    - `role` 'admin' | 'owner' | 'creator' | 'member' | 'guest', required
    - `status_changed_at` string, date-time, required
    - `status` 'active' | 'user_left' | 'removed_from_channel' | 'removed_from_workspace', required
  - `settings` object, required
  - `phones` WorkspacePhone[], required
    - `_id` string, nullable
    - `destination_workspace_id` string, nullable
    - `number` string, required
    - `parent_phone` string, nullable
    - `type` 'voicemail', required
    - `label` string, required
    - `message_url` string, nullable
    - `phone_sid` string, nullable
  - `background_color` string, nullable, required
  - `watermark_image_url` string, nullable, required
  - `conversation_default` boolean, required
  - `invitation_mode` 'anyone' | 'admin-only' | 'any-member', required
  - `sso_email_domain` string, nullable, required
  - `scim_provider` string, nullable, required
  - `scim_connection_name` string, nullable, required
  - `is_retention_enabled` boolean, nullable
  - `retention_days` number, nullable
  - `who_can_change_conversation_retention` Role[], nullable
  - `who_can_mark_messages_as_preserved` Role[], nullable
  - `retention_days_async_meeting` number, nullable
  - `domain_referral_mode` 'do-not-inform' | 'automatic' | 'request' | 'share-instructions', required
  - `domain_referral_message` string, nullable
  - `domain_referral_title` string, nullable
  - `domains` string[], required

---

[API](https://skmtc.dev/carbonvoice/apis/carbon-voice-api.md) · [All operations](https://skmtc.dev/carbonvoice/apis/carbon-voice-api/llms.txt) · [OpenAPI document](https://skmtc.dev/carbonvoice/apis/carbon-voice-api/revisions/b91c5c845122?raw)