organizations.createOrganization

POST

/v1/organizations

const url = 'https://example.com/v1/organizations';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/v1/organizations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example" }'

Creates an organization. You become its Super Administrator. The platform settings say who can do this.

Authorizations

token
session

Request Body^required

application/json

object

name

required

string

>= 1 characters <= 120 characters

Example ^generated

{
  "name": "example"
}

Responses

200

Success

application/json

object

required

string

name

required

string

status

required

string

Allowed values: active suspended

createdAt

required

string

Example

{
  "status": "active"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

OrganizationCreationDisabled | MembershipRequired | ForbiddenOrigin

application/json

Any of:

object

_tag

required

string

Allowed values: OrganizationCreationDisabled

Example

{
  "_tag": "OrganizationCreationDisabled"
}

503

OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: OrganizationStorageUnavailable

Example

{
  "_tag": "OrganizationStorageUnavailable"
}

organizations.createOrganization

Authorizations

Request Bodyrequired

Example generated

Responses

200

Example

401

Example

403

Example

503

Example

Request Body^required

Example ^generated