UpdateUserContactInfo API¶

Updates the email address and mobile number of the specified infoRouter user in a single call.

Endpoint¶

/srv.asmx/UpdateUserContactInfo

Methods¶

• GET /srv.asmx/UpdateUserContactInfo?authenticationTicket=...&userName=...&emailAddress=...&mobileNumber=...
• POST /srv.asmx/UpdateUserContactInfo (form data)
• SOAP Action: http://tempuri.org/UpdateUserContactInfo

Parameters¶

Response¶

Success Response¶

<response success="true" error="" />

Error Response¶

<response success="false" error="[ErrorCode] Error message" />

Required Permissions¶

An administrator's account (the sysadmin account or a member of [Administrators]) can be changed by administrators only; anyone else is refused with 4030. See AdministrativeRoles.

System administrator or the user themselves. A user can update their own contact info; a system administrator can update any user's contact info.

Example¶

GET Request¶

GET /srv.asmx/UpdateUserContactInfo
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &userName=jdoe
  &emailAddress=john.doe%40example.com
  &mobileNumber=%2B15551234567
HTTP/1.1

POST Request¶

POST /srv.asmx/UpdateUserContactInfo HTTP/1.1
Content-Type: application/x-www-form-urlencoded

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&userName=jdoe
&emailAddress=john.doe@example.com
&mobileNumber=+15551234567

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:UpdateUserContactInfo>
      <tns:authenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:authenticationTicket>
      <tns:userName>jdoe</tns:userName>
      <tns:emailAddress>john.doe@example.com</tns:emailAddress>
      <tns:mobileNumber>+15551234567</tns:mobileNumber>
    </tns:UpdateUserContactInfo>
  </soap:Body>
</soap:Envelope>

JavaScript¶

Every call answers XML with HTTP 200, success or not, so success is the thing to branch on and errorCode is the number to report.

async function call(action, params) {
  const response = await fetch(`/srv.asmx/${action}?${new URLSearchParams(params)}`);
  const root = new DOMParser()
    .parseFromString(await response.text(), 'text/xml')
    .documentElement;

  if (root.getAttribute('success') !== 'true') {
    throw new Error(`${root.getAttribute('errorCode')}: ${root.getAttribute('error')}`);
  }
  return root;
}

Sets one user's email address and mobile number together.

await call('UpdateUserContactInfo', {
  authenticationTicket: ticket,
  userName: 'jsmith',
  emailAddress: 'jane.smith@example.com',
  mobileNumber: '+15551234567',
});

mobileNumber is optional, and an empty one clears the stored number rather than leaving it alone. Read the current value with GetUser and send it back if it is to be kept. Neither value is validated.

Notes¶

• To update only email without changing the mobile number, use UpdateUserEmail instead.
• The email address is used for notifications, workflow alerts, and password reset emails.
• The mobile number is stored as a plain string; no format validation is enforced server-side.
• Passing an empty string "" for emailAddress or mobileNumber clears that field. To keep a field unchanged, pass its current value — retrieve it first with GetUser (attributes Email and MobileNumber on the <User> element).
• Via SOAP, passing null for emailAddress or mobileNumber preserves the existing value without clearing it. This null-preservation is not available through the HTTP GET/POST endpoints.

Related APIs¶

• GetUser - Get the current email, mobile number, and other user properties
• UpdateUserEmail - Update email address only
• UpdateUserProfile - Update the user's name, username, and authentication source
• UpdateUserPreferences - Update notification and display preferences

Error Codes¶

The errorCode values this operation returns, checked against a running server: