Skip to content

DocuSign: Updates a user's email address

DocuSign admin.adminUserUsersUpdateEmailAddressesV2: arguments, response, policy and SDK examples.

← Admin operations · Get started

Operation docusign.admin_user_users_updateemailaddressesv2

Provider route: POST /Management/v2/organizations/{organizationId}/users/email_addresses. 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["admin"]["adminUserUsersUpdateEmailAddressesV2"]>[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.admin.adminUserUsersUpdateEmailAddressesV2(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.admin.admin_user_users_update_email_addresses_v2(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.organizationIdstringRequired within parentFormat: uuid
bodyModelRequired within parentExpand Updates a user’s email address — request body — body

Referenced models: Updates a user’s email address — request body — body

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Updates a user’s email address — response body

Referenced models: Updates a user’s email address — response body

Updates a user's email address — response body
FieldTypePresenceDescription and constraints
$objectRootThe results of changing a user's information.
successbooleanOptionalWhen **true,** the request to change user information succeeded.
usersarrayOptionalA list of users whose email addresses have been updated.
users[]ModelEach itemExpand Updates a user's email address — response body — users item

Referenced models: Updates a user's email address — response body — users item

Updates a user's email address — request body — body
FieldTypePresenceDescription and constraints
$objectRootA change email request.
usersarrayOptionalA list of users whose email address to change.
users[]ModelEach itemExpand Updates a user's email address — request body — body users item

Referenced models: Updates a user's email address — request body — body users item

Updates a user's email address — response body — users item
FieldTypePresenceDescription and constraints
$objectRootError result of attempting to change a user's email address.
emailstringOptionalThe email address.
error_detailsModelOptionalExpand Updates a user's email address — response body — users item error details
Error results.
idstringOptionalThe ID of the user whose email address has been updated.
Format: uuid
site_idJSONOptional
site_id (anyOf 1)integerAlternativeThe site ID.
Format: int32
site_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Updates a user's email address — response body — users item error details

Updates a user's email address — request body — body users item
FieldTypePresenceDescription and constraints
$objectRootAnd individual change of email.
emailstringRequired within parentThe new email address.
idstringRequired within parentThe ID of the users whose email address you want to change.
Format: uuid
site_idintegerRequired within parentThe site ID.
Format: int32
Updates a user's email address — response body — users item error details
FieldTypePresenceDescription and constraints
$objectRootErrors.
errorstringOptionalThe code for the error.
error_descriptionstringOptionalA description of the error.

SDK function policy ID: docusign.admin_user_users_updateemailaddressesv2. Catalog operation: admin:User_Users_UpdateEmailAddressesV2. 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.

Required provider scopes: ["user_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.