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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.organizationId | string | Required within parent | Format: uuid |
body | Model | Required within parent | Expand Updates a user’s email address — request body — body |
Referenced models: Updates a user’s email address — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Updates a user’s email address — response body |
Referenced models: Updates a user’s email address — response body
Schemas
Section titled “Schemas”Updates a user's email address — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The results of changing a user's information. |
success | boolean | Optional | When **true,** the request to change user information succeeded. |
users | array | Optional | A list of users whose email addresses have been updated. |
users[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A change email request. |
users | array | Optional | A list of users whose email address to change. |
users[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Error result of attempting to change a user's email address. |
email | string | Optional | The email address. |
error_details | Model | Optional | Expand Updates a user's email address — response body — users item error details Error results. |
id | string | Optional | The ID of the user whose email address has been updated. Format: uuid |
site_id | JSON | Optional | |
site_id (anyOf 1) | integer | Alternative | The site ID. Format: int32 |
site_id (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | And individual change of email. |
email | string | Required within parent | The new email address. |
id | string | Required within parent | The ID of the users whose email address you want to change. Format: uuid |
site_id | integer | Required within parent | The site ID. Format: int32 |
Updates a user's email address — response body — users item error details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Errors. |
error | string | Optional | The code for the error. |
error_description | string | Optional | A description of the error. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"]