Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

/ admin / contactUpdate

  • Article
  • 2 minutes to read

Description

Invoke this method to update a contact record.

API Details

  • Status:
  • The required privilege level to invoke this method is user
  • The supported database role for this method is none
System Rights Database Rights Mail Rights Calendar Rights
sys.a.managePortalAccounts
 --- --- ---

Request Parameters

The contactUpdate method takes the following input parameters.

Note

When sending a JSON request payload to the API, the order of parameters is not significant. However, for XML request payloads, parameters must be provided in the exact order specified in this documentation to comply with input validation requirements.

Name Type Attributes Description
contactRecordId xs:unsignedInt Optional The unique ID of the contact record to update. If not specified then the contactId parameter is required and will be used to identify the contact record. If the contactId identifies more then one record then no update will be made and an error will be returned.
contactId xs:string Optional The login ID of the contact to update. This will be mapped to the login Id property of the contact record.
status accountStatusType Optional The status of the contact.
firstName nameType Optional The first name of the contact.
lastName xs:string Optional The last name of the contact.
jobTitle xs:string Optional The job title of the user.
phone xs:string Optional The direct dial telephone number for the user.
email rfc822AddressType Optional The email for the user.
company xs:string Optional The company the contact works for.
timeZone xs:string Optional The default Time Zone applied to this user. If you want to get a list of timezones, please see the time::getTimezoneList.
language xs:language Optional The assigned language of the user. The default value will be picked up from the admin tool settings.
countryCode countryCodeType Optional The default country code of the user. The default value will be picked up from the admin tool settings.
enable2fa twofaMethodType Optional
Default=disabled		 Set this to use two-factor authentication method for this account.

Response Parameters

This method returns no response parameters.

  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document