Skip to main content

Update sub-organization

PATCH 
/bv/org/v1/sub-orgs/:id

Modifies the details of a specific sub-organization within the main organization using the provided access token.

Required field(s):

  • name
  • parent_id
  • type
  • owner_email
  • Returns a 404/NotFound error if any requested resource is not found.
  • Returns a 400/BadRequest error if any request body is invalid.
  • Returns a 400/BadRequest with ERROR_REASON_HAS_APPENDED_SUB_ORGS error if updating the parent_id to a sub-organization that already has appended organizations.

Request​

Path Parameters

    id stringrequired

    Required. The unique id of the sub-organization.

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.

Body

required
    parent_id string

    Input only. The parent organization id to update to the sub-organization.

    description string

    Input only. The description to update to the sub-organization.

    plan_ids string[]

    Input only. The assigned plan id to update to the sub-organization.

    billing_cycle int32

    Input only. The billing cycle to update to the sub-organization.

    contract_valid_start_time date-time

    Input only. The contract start day to update to the business sub-organization. It's valid when the type is ORGANIZATION_TYPE_BUSINESS.

    contract_months int32

    Input only. The contract months to update to the business sub-organization. It's 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 to update to the business sub-organization. It's valid when the type is ORGANIZATION_TYPE_BUSINESS. This field is mutually exclusive to contract_months 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.

    clear_next_contract_setting boolean

    Input only. If set to true, will discard the next contract setting.

    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​

A successful response.

Schema

    object

Loading...