Skip to main content

Batch create accounts

POST 

/bv/account/v1/accounts

Creates multiple accounts without associating them with an organization. The maximum number of accounts that can be created at once is 10.

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.

Body

required
    accounts object[]
  • 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.

    role_type string

    Possible values: [ROLE_TYPE_OWNER, ROLE_TYPE_ADMIN, ROLE_TYPE_STAFF, ROLE_TYPE_DEVELOPER]

    Optional. The role of account. If the role type is not specified, the default role will be set to staff.

    attrs object
    property name* string
    need_confirm boolean

    Optional. Need to send confirm email to account email. Default: false.

  • ]

Responses

A successful response.

Schema
    accounts object[]
  • Array [
  • account object
    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 string

    Possible values: [ROLE_TYPE_OWNER, ROLE_TYPE_ADMIN, ROLE_TYPE_STAFF, ROLE_TYPE_DEVELOPER]

    Optional. The role of account. If the role type is not specified, the default role will be set to staff.

    status string

    Possible values: [ACCOUNT_STATUS_ACTIVATED, ACCOUNT_STATUS_DEACTIVATED]

    Output only. The 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
    created_status string

    Possible values: [CREATED_ACCOUNT_STATUS_SUCCEED, CREATED_ACCOUNT_STATUS_EXIST, CREATED_ACCOUNT_STATUS_FAILED, CREATED_ACCOUNT_STATUS_JOIN_ORG_FAILED]

  • ]
Loading...