Skip to main content
POST
/
v1
/
organizations
Create Organization
curl --request POST \
  --url https://{tenant}.mindbridge.ai/api/v1/organizations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "externalClientCode": "<string>",
  "managerUserIds": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "version": 123,
  "creationDate": "2023-11-07T05:31:56Z",
  "lastModifiedDate": "2023-11-07T05:31:56Z",
  "createdUserInfo": {
    "userId": "<string>",
    "userName": "<string>"
  },
  "lastModifiedUserInfo": {
    "userId": "<string>",
    "userName": "<string>"
  },
  "name": "<string>",
  "externalClientCode": "<string>",
  "managerUserIds": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

The name of the organization.

Maximum string length: 80
externalClientCode
string

The unique client ID applied to this organization.

Maximum string length: 80
managerUserIds
string[]

Identifies users assigned to the organization manager role.

Response

201 - application/json

Created

id
string

The unique object identifier.

version
integer<int64>

Indicates the data integrity version to ensure data consistency.

creationDate
string<date-time>

The date that the object was originally created.

lastModifiedDate
string<date-time>

The date that the object was last updated or modified.

createdUserInfo
User Info · object
read-only

Details about the user who created the object.

lastModifiedUserInfo
User Info · object
read-only

Details about the user who last modified or updated the object.

name
string

The name of the organization.

externalClientCode
string

The unique client ID applied to this organization.

managerUserIds
string[]

Identifies users assigned to the organization manager role.