Create a Company

Create a Company

application/json

Request Body

• name string required

  name of the company to be created.

• email string

  Email address for the tenant administrator. If provided, contactName for the tenant administrator also needs to be provided

• contactName string

  Name of the tenant administrator. If provided, email also needs to be provided.

• plans object[]

  Select data protection plans to use for the company. The plans that are selected are the plans that the tenant administrator can choose from.

  id int32

  name string
• alias string required

  The company domain or NetBIOS name

• emailSuffix string

  Supported domains for the company

• serviceCommcells object[]

  Used to add service commcells to the master commcell. Either id or name can be provided. If both are provided, id will be taken into consideration.

  id int32

  name string
• sendWelcomeEmail boolean

  send a welcome email on company creation to the tenant administrator.

• primaryDomain string

  The primary domain name of the company being created. Can be added only if an external domain is already present.

Responses

• 200
• 400
• 500

---

Success

application/json

• Schema
• Example (from schema)

---

Schema

• id int32
• name string

{
  "id": 0,
  "name": "string"
}

Bad Request

Internal Server Error

POST /v4/company    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/webconsole/api

token

Body

{
  "name": "string",
  "email": "string",
  "contactName": "string",
  "plans": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "alias": "string",
  "emailSuffix": "string",
  "serviceCommcells": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "sendWelcomeEmail": true,
  "primaryDomain": "string"
}

curl -L -X POST 'https://localhost/webconsole/api/V4/company' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "email": "string",
  "contactName": "string",
  "plans": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "alias": "string",
  "emailSuffix": "string",
  "serviceCommcells": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "sendWelcomeEmail": true,
  "primaryDomain": "string"
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/company' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "email": "string",
  "contactName": "string",
  "plans": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "alias": "string",
  "emailSuffix": "string",
  "serviceCommcells": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "sendWelcomeEmail": true,
  "primaryDomain": "string"
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/company' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "email": "string",
  "contactName": "string",
  "plans": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "alias": "string",
  "emailSuffix": "string",
  "serviceCommcells": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "sendWelcomeEmail": true,
  "primaryDomain": "string"
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/company' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "email": "string",
  "contactName": "string",
  "plans": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "alias": "string",
  "emailSuffix": "string",
  "serviceCommcells": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "sendWelcomeEmail": true,
  "primaryDomain": "string"
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/company' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "email": "string",
  "contactName": "string",
  "plans": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "alias": "string",
  "emailSuffix": "string",
  "serviceCommcells": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "sendWelcomeEmail": true,
  "primaryDomain": "string"
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/company' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "email": "string",
  "contactName": "string",
  "plans": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "alias": "string",
  "emailSuffix": "string",
  "serviceCommcells": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "sendWelcomeEmail": true,
  "primaryDomain": "string"
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/company' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "email": "string",
  "contactName": "string",
  "plans": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "alias": "string",
  "emailSuffix": "string",
  "serviceCommcells": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "sendWelcomeEmail": true,
  "primaryDomain": "string"
}'