> ## Documentation Index > Fetch the complete documentation index at: https://speakeasy-20cf8bdf.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Update a workspace > Update a workspace by ID or slug. ## OpenAPI ````yaml patch /workspaces/{idOrSlug} openapi: 3.0.3 info: title: Dub API description: >- Dub is the modern link attribution platform for short links, conversion tracking, and affiliate programs. version: 0.0.1 contact: name: Dub Support email: support@dub.co url: https://dub.co/api license: name: AGPL-3.0 license url: https://github.com/dubinc/dub/blob/main/LICENSE.md servers: - url: https://api.dub.co description: Production API security: [] paths: /workspaces/{idOrSlug}: patch: tags: - Workspaces summary: Update a workspace description: Update a workspace by ID or slug. operationId: updateWorkspace parameters: - in: path name: idOrSlug description: The ID or slug of the workspace to update. schema: type: string description: The ID or slug of the workspace to update. required: true requestBody: content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 32 slug: type: string minLength: 3 maxLength: 48 logo: nullable: true anyOf: - type: string pattern: ^data:image\/(png|jpeg|jpg|gif|webp);base64, - type: string format: uri - type: string format: uri conversionEnabled: type: boolean responses: '200': description: The updated workspace. content: application/json: schema: $ref: '#/components/schemas/WorkspaceSchema' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '410': $ref: '#/components/responses/410' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' security: - token: [] x-codeSamples: - lang: python label: updateWorkspace source: |- from dub import Dub with Dub( token="DUB_API_KEY", ) as d_client: res = d_client.workspaces.update(id_or_slug="") # Handle response print(res) - lang: php label: updateWorkspace source: |- declare(strict_types=1); require 'vendor/autoload.php'; use Dub; $sdk = Dub\Dub::builder() ->setSecurity( 'DUB_API_KEY' ) ->build(); $response = $sdk->workspaces->update( idOrSlug: '', requestBody: $requestBody ); if ($response->workspaceSchema !== null) { // handle response } - lang: go label: updateWorkspace source: "package main\n\nimport(\n\t\"context\"\n\tdubgo \"github.com/dubinc/dub-go\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := dubgo.New(\n dubgo.WithSecurity(\"DUB_API_KEY\"),\n )\n\n res, err := s.Workspaces.Update(ctx, \"\", nil)\n if err != nil {\n log.Fatal(err)\n }\n if res != nil {\n // handle response\n }\n}" - lang: ruby label: updateWorkspace source: |- require 'dub' Models = ::OpenApiSDK::Models s = ::OpenApiSDK::Dub.new( security: Models::Shared::Security.new( token: 'DUB_API_KEY', ), ) res = s.workspaces.update(id_or_slug: '') unless res.nil? # handle response end - lang: typescript label: updateWorkspace source: |- import { Dub } from "dub"; const dub = new Dub({ token: "DUB_API_KEY", }); async function run() { const result = await dub.workspaces.update(""); console.log(result); } run(); components: schemas: WorkspaceSchema: type: object properties: id: type: string description: The unique ID of the workspace. name: type: string description: The name of the workspace. slug: type: string description: The slug of the workspace. logo: type: string nullable: true default: null description: The logo of the workspace. inviteCode: type: string nullable: true description: The invite code of the workspace. plan: type: string enum: - free - pro - business - business plus - business extra - business max - advanced - enterprise description: The plan of the workspace. planTier: type: number nullable: true description: The tier of the workspace's plan. stripeId: type: string nullable: true description: The Stripe ID of the workspace. billingCycleStart: type: number description: The date and time when the billing cycle starts for the workspace. paymentFailedAt: type: string nullable: true description: The date and time when the payment failed for the workspace. stripeConnectId: type: string nullable: true description: The Stripe Connect ID of the workspace. totalLinks: type: number description: The total number of links in the workspace. usage: type: number description: The usage of the workspace. usageLimit: type: number description: The usage limit of the workspace. linksUsage: type: number description: The links usage of the workspace. linksLimit: type: number description: The links limit of the workspace. payoutsUsage: type: number description: >- The dollar amount of partner payouts processed in the current billing cycle (in cents). payoutsLimit: type: number description: >- The max dollar amount of partner payouts that can be processed within a billing cycle (in cents). payoutFee: type: number description: >- The processing fee (in decimals) for partner payouts. For card payments, an additional 0.03 is added to the fee. Learn more: https://d.to/payouts domainsLimit: type: number description: The domains limit of the workspace. tagsLimit: type: number description: The tags limit of the workspace. foldersUsage: type: number description: The folders usage of the workspace. foldersLimit: type: number description: The folders limit of the workspace. groupsLimit: type: number description: The groups limit of the workspace. networkInvitesLimit: type: number description: The weekly network invites limit of the workspace. usersLimit: type: number description: The users limit of the workspace. aiUsage: type: number description: The AI usage of the workspace. aiLimit: type: number description: The AI limit of the workspace. conversionEnabled: type: boolean description: >- Whether the workspace has conversion tracking enabled automatically for new links (d.to/conversions). dotLinkClaimed: type: boolean description: >- Whether the workspace has claimed a free .link domain. (dub.link/free) createdAt: type: string description: The date and time when the workspace was created. users: type: array items: type: object properties: role: type: string enum: - owner - member description: The role of the authenticated user in the workspace. defaultFolderId: type: string nullable: true description: The ID of the default folder for the user in the workspace. required: - role - defaultFolderId description: The role of the authenticated user in the workspace. domains: type: array items: type: object properties: slug: type: string description: The domain name. example: acme.com primary: type: boolean default: false description: Whether the domain is the primary domain for the workspace. verified: type: boolean default: false description: Whether the domain is verified. required: - slug - primary - verified description: The domains of the workspace. flags: type: object additionalProperties: type: boolean description: >- The feature flags of the workspace, indicating which features are enabled. store: type: object nullable: true additionalProperties: {} description: The miscellaneous key-value store of the workspace. allowedHostnames: type: array nullable: true items: type: string description: Specifies hostnames permitted for client-side click tracking. example: - dub.sh ssoEmailDomain: type: string nullable: true ssoEnforcedAt: type: string nullable: true required: - id - name - slug - logo - inviteCode - plan - planTier - stripeId - billingCycleStart - paymentFailedAt - stripeConnectId - totalLinks - usage - usageLimit - linksUsage - linksLimit - payoutsUsage - payoutsLimit - payoutFee - domainsLimit - tagsLimit - foldersUsage - foldersLimit - groupsLimit - networkInvitesLimit - usersLimit - aiUsage - aiLimit - conversionEnabled - dotLinkClaimed - createdAt - users - domains - store - allowedHostnames - ssoEmailDomain - ssoEnforcedAt title: Workspace responses: '400': description: >- The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). content: application/json: schema: x-speakeasy-name-override: BadRequest type: object properties: error: type: object properties: code: type: string enum: - bad_request description: A short code indicating the error code returned. example: bad_request message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: https://dub.co/docs/api-reference/errors#bad-request required: - code - message required: - error '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. content: application/json: schema: x-speakeasy-name-override: Unauthorized type: object properties: error: type: object properties: code: type: string enum: - unauthorized description: A short code indicating the error code returned. example: unauthorized message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: https://dub.co/docs/api-reference/errors#unauthorized required: - code - message required: - error '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server. content: application/json: schema: x-speakeasy-name-override: Forbidden type: object properties: error: type: object properties: code: type: string enum: - forbidden description: A short code indicating the error code returned. example: forbidden message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: https://dub.co/docs/api-reference/errors#forbidden required: - code - message required: - error '404': description: The server cannot find the requested resource. content: application/json: schema: x-speakeasy-name-override: NotFound type: object properties: error: type: object properties: code: type: string enum: - not_found description: A short code indicating the error code returned. example: not_found message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: https://dub.co/docs/api-reference/errors#not-found required: - code - message required: - error '409': description: >- This response is sent when a request conflicts with the current state of the server. content: application/json: schema: x-speakeasy-name-override: Conflict type: object properties: error: type: object properties: code: type: string enum: - conflict description: A short code indicating the error code returned. example: conflict message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: https://dub.co/docs/api-reference/errors#conflict required: - code - message required: - error '410': description: >- This response is sent when the requested content has been permanently deleted from server, with no forwarding address. content: application/json: schema: x-speakeasy-name-override: InviteExpired type: object properties: error: type: object properties: code: type: string enum: - invite_expired description: A short code indicating the error code returned. example: invite_expired message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: https://dub.co/docs/api-reference/errors#invite-expired required: - code - message required: - error '422': description: >- The request was well-formed but was unable to be followed due to semantic errors. content: application/json: schema: x-speakeasy-name-override: UnprocessableEntity type: object properties: error: type: object properties: code: type: string enum: - unprocessable_entity description: A short code indicating the error code returned. example: unprocessable_entity message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: >- https://dub.co/docs/api-reference/errors#unprocessable-entity required: - code - message required: - error '429': description: >- The user has sent too many requests in a given amount of time ("rate limiting") content: application/json: schema: x-speakeasy-name-override: RateLimitExceeded type: object properties: error: type: object properties: code: type: string enum: - rate_limit_exceeded description: A short code indicating the error code returned. example: rate_limit_exceeded message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: >- https://dub.co/docs/api-reference/errors#rate-limit_exceeded required: - code - message required: - error '500': description: The server has encountered a situation it does not know how to handle. content: application/json: schema: x-speakeasy-name-override: InternalServerError type: object properties: error: type: object properties: code: type: string enum: - internal_server_error description: A short code indicating the error code returned. example: internal_server_error message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: >- https://dub.co/docs/api-reference/errors#internal-server_error required: - code - message required: - error securitySchemes: token: type: http description: Default authentication mechanism scheme: bearer x-speakeasy-example: DUB_API_KEY ````