Skip to content

DocuSign: Update Workspace

DocuSign esignature.esignatureWorkspacePutWorkspace: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_workspace_putworkspace

Provider route: PUT /restapi/v2.1/accounts/{accountId}/workspaces/{workspaceId}. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureWorkspacePutWorkspace"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.esignature.esignatureWorkspacePutWorkspace(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_docusign import DocuSignIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.esignature.esignature_workspace_put_workspace(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
path.workspaceIdstringRequired within parent
bodyModelOptionalExpand Get Workspace — response body

Referenced models: Get Workspace — response body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Get Workspace — response body

Referenced models: Get Workspace — response body

Get Workspace — response body
FieldTypePresenceDescription and constraints
$objectRootA Docusign workspace is a collaboration area for sharing files and data.
billableAccountIdstringOptionalThe ID of the account to bill.
callerInformationModelOptionalExpand Get Workspace — response body — caller Information
createdstringOptionalThe UTC DateTime when the workspace user authorization was created.
createdByInformationModelOptionalExpand Get Workspace — response body — caller Information
Details about the user who created the workspace.
lastModifiedstringOptionalUtc date and time the comment was last updated (can only be done by creator.)
lastModifiedByInformationModelOptionalExpand Get Workspace — response body — caller Information
Details about the user who last modified the workspace.
settingsModelOptionalExpand Get Workspace — response body — settings
Information about the settings for the workspace.
statusstringOptionalIndicates the envelope status. Valid values are:

* sent - The envelope is sent to the recipients.
* created - The envelope is saved as a draft and can be modified and sent later.
workspaceBaseUrlstringOptionalThe relative URL for accessing the workspace.
workspaceDescriptionstringOptionalText describing the purpose of the workspace.
workspaceIdstringOptionalThe ID of the workspace, always populated.
workspaceNamestringOptionalThe name of the workspace.
workspaceUristringOptionalThe relative URI for accessing the workspace.

Referenced models: Get Workspace — response body — settings, Get Workspace — response body — caller Information

Get Workspace — response body — settings
FieldTypePresenceDescription and constraints
$objectRootThis object provides information about the settings for the workspace.
commentsAllowedstringOptionalWhen **true,** commenting on the documents in the workspace is allowed.
Get Workspace — response body — caller Information
FieldTypePresenceDescription and constraints
$objectRootThis object represents the workspace user. This property is only returned in response to user specific GET call.
accountIdstringOptionalThe account ID associated with the workspace user.
accountNamestringOptionalThe name of the account that the workspace user belongs to.
activeSincestringOptionalThe UTC DateTime when the user joined the workspace.
createdstringOptionalThe UTC DateTime when the workspace user was created.
createdByIdstringOptionalThe ID of the user who created this workspace user.
emailstringOptionalThe workspace user's email address.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
invitationEmailBlurbstringOptionalThe text of the workspace invitation email message sent to the user.
invitationEmailSubjectstringOptionalThe subject line of the workspace invitation email message sent to the user.
lastModifiedstringOptionalThe UTC DateTime that the workspace user was last modified.
lastModifiedByIdstringOptionalThe ID of the user who last modified the workspace user.
statusstringOptionalFilters the results by user status.
You can specify a comma-separated
list of the following statuses:

* ActivationRequired
* ActivationSent
* Active
* Closed
* Disabled
typestringOptionalType of the user. Valid values: type_owner, type_participant.
userIdstringOptionalThe ID of the workspace user.
userNamestringOptionalThe name of workspace user.
workspaceIdstringOptionalThe ID of the workspace.
workspaceUserBaseUrlstringOptionalThe URL for accessing the workspace user.
workspaceUserIdstringOptionalThe ID of the workspace user.
workspaceUserUristringOptionalThe URI for accessing the workspace user.

Referenced models: Locks a template — response body — error Details

Locks a template — response body — error Details
FieldTypePresenceDescription and constraints
$objectRootThis object describes errors that occur. It is only valid for responses and ignored in requests.
errorCodestringOptionalThe code associated with the error condition.
messagestringOptionalA brief message describing the error condition.

SDK function policy ID: docusign.esignature_workspace_putworkspace. Catalog operation: esignature:Workspace_PutWorkspace. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.