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 / contactCreate

  • Article
  • 2 minutes to read

Description

Invoke this method to create a contact.

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 contactCreate method takes the following input parameters. It is important to note that the parameters must be passed to the method in the same order as they appear here in order to satisfy the requirement of the input validation checks.

Name Type Attributes Description
contactId xs:string Required The ID of the contact to create. This will be mapped to the login ID property of the contact record.
status accountStatusType Optional
Default=active		 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.
grantPortalAccess portalGrantContactAccessType Optional If you want to grant this contact access to a guest portal you can provide the information here.
authType xs:string Optional
Default=SHA		 The type of authentication credential to set. The default is SHA.
authCredential passwordType Optional The credential password (Base64 encoded) string. If not specified then a random password will be generated and set to ensure that the security integrity of the contact record is maintained.
enable2fa twofaMethodType Optional
Default=disabled		 Set this to use two-factor authentication method for this account.

Response Parameters

Name Type Attributes Description
contactRecordId xs:unsignedInt Optional The unique ID of the contact record created.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document