Add an Organization

Add a new organization.

Request URL

POST {base_url}/{api_path}/organization/create?access_token={access_token}

Request parameters

Table 1.
Parameter Required Type Description
name Yes String Organization name.
parent_id Yes Integer Parent organization ID.
Note: You can query the organization's ID using Search Specific Organizations.

Response parameters

Table 2.
Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
id Integer The unique ID of the organization.

Examples

Request example

Add an organization named UA group under the root organization.

POST /openapi/v1.0/organization/create?access_token=hlVf2mmJD9A94tLv6PYVmEU3bO8wUgZx 

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json

{
    "name": "UA group",
    "parent_id": 1
}

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "id": 5
}