TRY NEW VERSION

Try now New API BETA

Try out the new view and capabilities of the API documentation

START

POST /api/portal/register

Description

Registers a new portal with the parameters specified in the request.

Parameters
Name Description Type Example
firstName*
sent in Body
Portal owner first name string "John"
email*
sent in Body
Portal owner email address string "test@example.com"
language
sent in Body
Portal language string "en"
lastName*
sent in Body
Portal owner last name string "Smith"
password
sent in Body
Portal owner password string "123456"
phone
sent in Body
Portal owner phone number string "+123456789"
portalName*
sent in Body
Portal name string "example"
timeZoneName
sent in Body
Portal time zone string "UTC"
* - required field
Returns

The link for portal activation and portal description

Example Response
{
    "reference": "https://example.com/confirm.aspx",
    "tenant": {
        "created": "2010-07-07T15:46:00",
        "domain": "example.com",
        "language": "en-US",
        "ownerId": "78e1e841-8314-48465-8fc0-e7d6451b6475",
        "portalName": "example",
        "status": "Active",
        "tenantId": 1,
        "timeZoneName": "UTC"
    }
}