Users: updateEmailAddress

Required scopes: user_write

Updates a user's email address.

Request

HTTP request

POST /v2/organizations/{organizationId}/users/email_addresses

Parameters

Parameter NameValueDescription
Path Parameters
organizationIdstring

The organization ID Guid

Request Body

request

SDK Method

Users::updateEmailAddress

Definitions

DocuSign.API.Organizations.Web.Models.RestApi.Common.ErrorDetails

Errors.

errorstring

Short description of the error.

error_descriptionstring

A longer description of the error.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.UsersUpdateResponse

Results of changing a user's information.

successboolean

If true, the request to change user information succeeded.

users[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.UserUpdateResponse]

A list of users whose information could not be changed.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.UserUpdateResponse

Error result of attempting to change a user's email address.

idstring

The user ID.

site_idinteger

The site ID.

emailstring

The email address

error_detailsDocuSign.API.Organizations.Web.Models.RestApi.Common.ErrorDetails

Error results.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Request.UpdateUsersEmailRequest

A change email request.

users[DocuSign.API.Organizations.Web.Models.RestApi.v2.Request.UpdateUserEmailRequest]

A list of users whose email address to change.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Request.UpdateUserEmailRequest

And individual change of email.

idstring

The ID of the users whose email address you want to change.

site_idinteger

The site ID.

emailstring

The new email address.

}} />