SetUserDefaultEmail

The SetUserDefaultEmail method modifies a user's default email and creates 1 when necessary.

On this page

Usage

Privileges. This method requires Update privileges.

Parameters.

The parameters for the SetUserDefaultEmail method are described in the following table.
Parameter	Data Type	Value
sessionToken	String	Valid sessionToken returned by the general.CreateUserSession method
userId	Integer	Internal ID of the user returned by the accesscontrol.LookupUserId method
email_address	String	Email address that you want to set as the default

Output. This method returns an integer. If the method is successful, the returned value is an integer. If there is a failure, the API issues an exception.

Samples

Sample C# Call

iReturnCode = accesscontrol.SetUserDefaultEmail(sSessionToken, 123, “name@company.com”);

Sample Request

The following is a sample SOAP 1.1 request and response. The placeholders shown would be replaced with actual values. SOAP 1.2 also is supported.

POST /archer/ws/accesscontrol.asmx HTTP/1.1

Host: staging

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://archer-tech.com/webservices/SetUserDefaultEmail"

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Body>

<sessionToken>string</sessionToken>

<email_address>string</email_address>

</SetUserDefaultEmail>

</soap:Body>

</soap:Envelope>

Sample Response

HTTP/1.1 200 OK