platform.updatePlatformOrganization

PATCH

/v1/platform/organizations/{organizationId}

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

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

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

Suspends an organization or makes it active again. Nobody can use a suspended organization, and its tokens stop working.

Authorizations

token
session

Parameters

Path Parameters

organizationId

required

string

Request Body^required

application/json

object

status

required

string

Allowed values: active suspended

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

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

application/json

Any of:

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

Example

{
  "_tag": "Forbidden"
}

404

OrganizationNotFound

application/json

object

_tag

required

string

Allowed values: OrganizationNotFound

organizationId

required

string

Example

{
  "_tag": "OrganizationNotFound"
}

409

@nmnmcc/ability/Authorizer/Pending

application/json

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "Pending"
}

503

PlatformUnavailable | OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: PlatformUnavailable

Example

{
  "_tag": "PlatformUnavailable"
}

platform.updatePlatformOrganization

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

200

Example

401

Example

403

Example

404

Example

409

Example

503

Example

Request Body^required