Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

The CreateUser api allow to create a user for a company, if the company settings allow this operation

...

Parameter

Data type

Description


Request

 Text

 APItokenToCompanyCode CreateUser

Mandatory

CompanyToken

Token

Token you got from 3G DPO to operate this API

Mandatory

userCompanyToken

Token

Token you got from 3G DPO customer

Mandatory

userFirstName NameFirst name of the userMandatory
userLastNameNameLast name of the userMandatory
userEmailEmailUser emailMandatory
userPhoneCode

ISO code

Customer country ISO 2 letter code

Optional
userPhoneNumberNumberUser Phone numberOptional
userSendSmsBooleanSend SMS to userOptional
userEmailProfileNumber

Email type to send to user:

1- regular welcome email

2- admin welcome email

deprecated


Request example:


Code Block
languagexml
themeConfluence
<API3G>
  <CompanyToken>68B90B5E-25F6-4146-8AB1-C7A3A0C41A7F</CompanyToken>
  <Request>CreateUser</Request>
  <userCompanyToken>AB77238D-4C7C-44EE-AF4F-E23E84184042</userCompanyToken>
  <userLastName>Alain</userLastName>
  <userFirstName>Aznavour</userFirstName>
  <userEmail>test@test.com</userEmail>
</API3G>

...

Code

Explanation

000

Success

902

Data mismatch or other error

801

Request missing company token

802

Wrong CompanyToken

803No request or error in Request type name

804

Error in XML

999No permissions - contact support team

...