Platform API ReferenceOrganization

Update an Organization

Update an Organization's details.

Path parameters

organizationIdstringRequired
The Organization's ID.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
billingEmailstringRequired
The Organization's billing email.
isScimEnabledbooleanRequired
Whether SCIM is enabled for the Organization.
namestringRequired<=50 characters
The name of the Organization.

Response

OK
createdAtdatetime

The time when the Organization was created in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

createdByobject
idstring
The Organization's ID.
isScimEnabledboolean
Whether SCIM is enabled for the Organization.
namestring
The Organization's name.
supportPlanenum
The Organization's support plan.
updatedAtdatetime

The time when the Organization was last updated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

updatedByobject
billingEmailstring or null
The Organization's billing email.
managedDomainslist of objects or null
The list of managed domains configured in the Organization.
paymentMethodenum or null
The Organization's payment method.
Allowed values:
productenum or null
The Organization's product type.
Allowed values:
productPlanslist of objects or null
statusenum or null
The Organization's status.
Allowed values:
trialExpiresAtdatetime or null

The time when the Organization’s trial expires in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ. Organizations that are no longer in Trial will not have a expiry date.

Errors