POST api/v2/admin/accounts/{id}
This api method creates a subaccount for your account. You need to pass in all the relevant details together with the master account id. A good amount of validation is added, so make sure that you follow the criteria for each of the attributes.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
Account id of the master account. To be able to link the master with the sub account. |
globally unique identifier |
Required |
Body Parameters
The details of the new account.
AccountV2RequestName | Description | Type | Additional information |
---|---|---|---|
Address |
The company's address for billing purposes. |
string |
None. |
CompanyName |
Company name the account is working for |
string |
None. |
Contact Email address of the account |
string |
Required |
|
Username |
Username of the account |
string |
Required |
Firstname |
Firstname of the account |
string |
Required |
LanguageID |
The account language. |
globally unique identifier |
None. |
Lastname |
Lastname of the account |
string |
Required |
MobilePhone |
Mobile number of the account |
string |
Matching regular expression pattern: ^(?=.*?\d.*?\d.*?\d.*?\d.*?\d)([+]?)([\d\s\(\)-]{5,20})$ |
Password |
Password of the account |
string |
Required |
TimeZone |
The Time zone the account. |
string |
None. |
WebSite |
The website of the account. |
string |
None. |
Request Formats
application/json, text/json
{ "UserPassword": "sample string 1", "Address": "sample string 2", "CompanyName": "sample string 3", "Email": "sample string 4", "Username": "sample string 5", "Firstname": "sample string 6", "LanguageID": "81a0c147-d147-4d57-a6be-e2b29f7aa4c2", "Lastname": "sample string 7", "MobilePhone": "sample string 8", "Password": "sample string 9", "TimeZone": "sample string 10", "TimeZoneInJavaFormat": "sample string 11", "WebSite": "sample string 12", "Credentials": { "SMSUsername": "sample string 1", "SMSPassword": "sample string 2" } }
application/xml, text/xml
<AccountV2Request xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Address>sample string 2</Address> <CompanyName>sample string 3</CompanyName> <Email>sample string 4</Email> <Username>sample string 5</Username> <Firstname>sample string 6</Firstname> <LanguageID>81a0c147-d147-4d57-a6be-e2b29f7aa4c2</LanguageID> <Lastname>sample string 7</Lastname> <MobilePhone>sample string 8</MobilePhone> <Password>sample string 9</Password> <TimeZone>sample string 10</TimeZone> <TimeZoneInJavaFormat>sample string 11</TimeZoneInJavaFormat> <WebSite>sample string 12</WebSite> <Credentials> <SMSUsername>sample string 1</SMSUsername> <SMSPassword>sample string 2</SMSPassword> </Credentials> <UserPassword>sample string 1</UserPassword> </AccountV2Request>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
ResponseOfAccountResponseName | Description | Type | Additional information |
---|---|---|---|
Error | Error |
None. |
|
ResponseData | ResponseDataOfAccountResponse |
None. |
Response Formats
application/json, text/json
{ "Error": { "ErrorCode": "sample string 1", "ErrorReason": "sample string 2" }, "ResponseData": { "Identification": { "UserId": "sample string 1" }, "Result": "sample string 1", "Detail": { "ID": "6f287682-cccd-4946-b8e3-afa7fe79bfc5" } } }
application/xml, text/xml
<ResponseOfAccountResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Error> <ErrorCode>sample string 1</ErrorCode> <ErrorReason>sample string 2</ErrorReason> </Error> <ResponseData> <Result>sample string 1</Result> <Identification> <UserId>sample string 1</UserId> </Identification> <Detail> <ID>6f287682-cccd-4946-b8e3-afa7fe79bfc5</ID> </Detail> </ResponseData> </ResponseOfAccountResponse>