Batch create sub organizations

POST 
/bv/org/v1/sub-orgs:batch

Create multiple sub-organizations once with all necessary details for each sub-organization.

Request

Header Parameters

x-bv-org-id stringrequired

To invoke this API using api_token, you need to set the x-bv-org-id header to specify the organization for which you want to perform the action.

application/json

Body

required

organizations object[]
Array [
name stringrequired
Required. The name of sub-organization.
parent_id stringrequired
Required. The appended parent organization id of the sub-organization.
type stringrequired
Possible values: [ORGANIZATION_TYPE_ROOT, ORGANIZATION_TYPE_GENERAL_DISTRIBUTOR, ORGANIZATION_TYPE_RESELLER, ORGANIZATION_TYPE_BUSINESS]
Required. The type of the sub-organization.
description string
Input only. The description of the sub-organization.
owner objectrequired
Required. The owner of the sub-organization.
email Required. The email of account (string)required
password string
Optional. The password of account. If the account is created by creating sub org api, not need to provide the password. The service will genrate password automatically. Password policy: Contains at least 1 number. Contains at least 1 special character. Contains at least 1 uppercase letter. Contains at least 1 lowercase letter.
first_name stringrequired
Required. The first name of account.
last_name stringrequired
Required. The last name of account.
need_confirm boolean
Optional. Need to send confirm email to account email. Default: false.
accounts object[]
Input only. The member of the sub-organization.
Array [
email Required. The email of account (string)required
password string
Optional. The password of account. If the account is created by creating sub org api, not need to provide the password. The service will genrate password automatically. Password policy: Contains at least 1 number. Contains at least 1 special character. Contains at least 1 uppercase letter. Contains at least 1 lowercase letter.
first_name stringrequired
Required. The first name of account.
last_name stringrequired
Required. The last name of account.
need_confirm boolean
Optional. Need to send confirm email to account email. Default: false.
]
plan_ids string[]
Input only. The assigned plan ids of the sub-organization.
billing_cycle int32
Input only. The billing cycle of the reseller sub-organization. It's required and valid when the type is ORGANIZATION_TYPE_RESELLER.
contract_valid_start_time date-time
Input only. The contract start day of the business sub-organization. It's required and valid when the type is ORGANIZATION_TYPE_BUSINESS.
contract_months int32
Input only. The contract months of the business sub-organization. It's required and valid when the type is ORGANIZATION_TYPE_BUSINESS. This field is mutually exclusive to contract_days field, it'll get the higher priority if both are provided. e.g. It'll use contract_months instead if both contract_months and contract_days are provided.
contract_days int32
Input only. The contract days of the business sub-organization. It's required and valid when the type is ORGANIZATION_TYPE_BUSINESS. This field is mutually exclusive to contract_months field, it'll get the lower priority if both are provided. e.g. It'll use contract_months instead if both contract_months and contract_days are provided.
time_zone string
Input only. The time zone to the sub-organization.
business_setting object
Optional. The business-specific configuration for the sub-organization. This field should only be provided when the sub-organization type is ORGANIZATION_TYPE_BUSINESS. It allows setting additional options specifically for business-type sub-organizations.
category Optional. The category of the business sub-organization. This field is optional and can contain custom classifications. Max length: 40 (string)
tax_id Optional. The tax ID of the business sub-organization. Max length: 8 (string)
enable_create_site boolean
Optional. Indicates whether the business sub-organization has permission to create sites. This field should only be provided when the business sub-organization plan is BVOne plan.
site_limit int32
Optional. The maximum number of sites that the business sub-organization can create. This field should only be provided when the business sub-organization plan is BVOne plan. This field is optional and must be within the range of 0 to 50, inclusive.
enable_custom_domain boolean
Optional. Indicates if the business sub-organization can enable a custom domain. This field should only be provided when the business sub-organization plan is BVOne plan.
marketplace_url string
Optional. The marketplace URL of the business sub-organization. This field should only be provided when the business sub-organization plan is CXM plan. Max length: 2000, must be a valid URL format.
]

Responses

200

A successful response.

application/json

Schema

Schema

organizations object[]
Array [
organization object
id string
Output only. The resource identifier of the organization.
name stringrequired
Required. The name of the sub-organization.
parent_id stringrequired
Required. The appended parent organization id of the sub-organization.
type string
Possible values: [ORGANIZATION_TYPE_ROOT, ORGANIZATION_TYPE_GENERAL_DISTRIBUTOR, ORGANIZATION_TYPE_RESELLER, ORGANIZATION_TYPE_BUSINESS]
Output only. Indicates the type of the organization.
status string
Possible values: [ORGANIZATION_STATUS_ACTIVATED, ORGANIZATION_STATUS_VERIFYING, ORGANIZATION_STATUS_FAIL_TO_VERIFY, ORGANIZATION_STATUS_DEACTIVATED, ORGANIZATION_STATUS_DELETING, ORGANIZATION_STATUS_DELETED, ORGANIZATION_STATUS_ACTIVATION_SCHEDULED]
Output only. Indicates the status of the organization.
description string
Input only. The description of the sub-organization.
owner objectrequired
Required. The owner of the sub-organization. The service will genrate account password automatically.
id string
Output only. The resource identifier of account.
email Required. The email of account (string)required
password string
Optional. The password of account. If the account is created by creating sub org api, not need to provide the password. The service will genrate password automatically. Password policy: Contains at least 1 number. Contains at least 1 special character. Contains at least 1 uppercase letter. Contains at least 1 lowercase letter.
first_name stringrequired
Required. The first name of account.
last_name stringrequired
Required. The last name of account.
role_type - ROLE_TYPE_CXM_ADMIN: CXM (string)
Possible values: [ROLE_TYPE_OWNER, ROLE_TYPE_ADMIN, ROLE_TYPE_STAFF, ROLE_TYPE_DEVELOPER, ROLE_TYPE_CONTENT_CONTRIBUTOR, ROLE_TYPE_CUSTOM, ROLE_TYPE_CXM_ADMIN, ROLE_TYPE_CXM_MODERATOR, ROLE_TYPE_CXM_CONTRIBUTOR, ROLE_TYPE_CXM_PARTICIPANT]
Output only. The role of account.
status string
Possible values: [ACCOUNT_STATUS_ACTIVATED, ACCOUNT_STATUS_DEACTIVATED]
Output only. The status of account.
created_status string
Possible values: [CREATED_ACCOUNT_STATUS_SUCCEED, CREATED_ACCOUNT_STATUS_EXIST, CREATED_ACCOUNT_STATUS_FAILED, CREATED_ACCOUNT_STATUS_JOIN_ORG_FAILED]
Outpu only. The created status of account.
attrs object
property name* string
need_confirm boolean
Optional. Need to send confirm email to account email. Default: false.
created_at date-time
updated_at date-time
accounts object[]
Optional. The member of the sub-organization. The service will genrate account password automatically.
Array [
id string
Output only. The resource identifier of account.
email Required. The email of account (string)required
password string
Optional. The password of account. If the account is created by creating sub org api, not need to provide the password. The service will genrate password automatically. Password policy: Contains at least 1 number. Contains at least 1 special character. Contains at least 1 uppercase letter. Contains at least 1 lowercase letter.
first_name stringrequired
Required. The first name of account.
last_name stringrequired
Required. The last name of account.
role_type - ROLE_TYPE_CXM_ADMIN: CXM (string)
Possible values: [ROLE_TYPE_OWNER, ROLE_TYPE_ADMIN, ROLE_TYPE_STAFF, ROLE_TYPE_DEVELOPER, ROLE_TYPE_CONTENT_CONTRIBUTOR, ROLE_TYPE_CUSTOM, ROLE_TYPE_CXM_ADMIN, ROLE_TYPE_CXM_MODERATOR, ROLE_TYPE_CXM_CONTRIBUTOR, ROLE_TYPE_CXM_PARTICIPANT]
Output only. The role of account.
status string
Possible values: [ACCOUNT_STATUS_ACTIVATED, ACCOUNT_STATUS_DEACTIVATED]
Output only. The status of account.
created_status string
Possible values: [CREATED_ACCOUNT_STATUS_SUCCEED, CREATED_ACCOUNT_STATUS_EXIST, CREATED_ACCOUNT_STATUS_FAILED, CREATED_ACCOUNT_STATUS_JOIN_ORG_FAILED]
Outpu only. The created status of account.
attrs object
property name* string
need_confirm boolean
Optional. Need to send confirm email to account email. Default: false.
created_at date-time
updated_at date-time
]
time_zone string
Optional. The time zone to the sub-organization. Default: Aisa/Taipei.
billing_cycle int32
Input only. The billing cycle of the reseller sub-organization. It's required and valid when the type is ORGANIZATION_TYPE_RESELLER.
contract_valid_start_time date-time
Input only. The contract start day of the business sub-organization. It's required and valid when the type is ORGANIZATION_TYPE_BUSINESS.
contract_months int32
Input only. The contract months of the business sub-organization. It's required and valid when the type is ORGANIZATION_TYPE_BUSINESS. This field is mutually exclusive to contract_days field, it'll get the higher priority if both are provided. e.g. It'll use contract_months instead if both contract_months and contract_days are provided.
contract_days int32
Input only. The contract days of the business sub-organization. It's required and valid when the type is ORGANIZATION_TYPE_BUSINESS. This field is mutually exclusive to contract_months field, it'll get the lower priority if both are provided. e.g. It'll use contract_months instead if both contract_months and contract_days are provided.
contract_valid_end_time date-time
Output only. The contract valid end day won't be valid after the day.
has_sub_orgs boolean
Output only. Indicates there are sub-organizations appended to the organization.
parent_name string
Output only. The name of appended parent organization.
license_key string
Output only.
created_at date-time
updated_at date-time
created_status string
Possible values: [CREATED_ORG_STATUS_SUCCEED, CREATED_ORG_STATUS_FAILED]
]

Example (from schema)

{
  "organizations": [
    {
      "organization": {
        "id": "string",
        "name": "string",
        "parent_id": "string",
        "type": "ORGANIZATION_TYPE_ROOT",
        "status": "ORGANIZATION_STATUS_ACTIVATED",
        "description": "string",
        "owner": {
          "id": "string",
          "email": "string",
          "password": "string",
          "first_name": "string",
          "last_name": "string",
          "role_type": "ROLE_TYPE_OWNER",
          "status": "ACCOUNT_STATUS_ACTIVATED",
          "created_status": "CREATED_ACCOUNT_STATUS_SUCCEED",
          "attrs": {},
          "need_confirm": true,
          "created_at": "2024-07-29T15:51:28.071Z",
          "updated_at": "2024-07-29T15:51:28.071Z"
        },
        "accounts": [
          {
            "id": "string",
            "email": "string",
            "password": "string",
            "first_name": "string",
            "last_name": "string",
            "role_type": "ROLE_TYPE_OWNER",
            "status": "ACCOUNT_STATUS_ACTIVATED",
            "created_status": "CREATED_ACCOUNT_STATUS_SUCCEED",
            "attrs": {},
            "need_confirm": true,
            "created_at": "2024-07-29T15:51:28.071Z",
            "updated_at": "2024-07-29T15:51:28.071Z"
          }
        ],
        "time_zone": "string",
        "billing_cycle": 0,
        "contract_valid_start_time": "2024-07-29T15:51:28.071Z",
        "contract_months": 0,
        "contract_days": 0,
        "contract_valid_end_time": "2024-07-29T15:51:28.071Z",
        "has_sub_orgs": true,
        "parent_name": "string",
        "license_key": "string",
        "created_at": "2024-07-29T15:51:28.071Z",
        "updated_at": "2024-07-29T15:51:28.071Z"
      },
      "created_status": "CREATED_ORG_STATUS_SUCCEED"
    }
  ]
}

400

A bad request response. The code is 3 means got an invalid argument. There are more HTTP status code mappings listed on here and gRPC code on here.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

401

A unauthenticated response. The header authorization was missing or unidentified.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

403

A forbidden response. It means that the provided authorization did not have enough permission to access the resource or the API.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

500

A server error response. There are more HTTP status code mappings listed on here.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...