Organization Lifecycle
Sets a new state for an organization
Sets a new state for an organization and creates an organization state
history record. An organization can be set to active or inactive.
Body
application/json
Body
The request schema to set an organization’s state.
The state of the organization to set.
Allowed values:activeinactivedeletingdeleted
Example:inactive
The reason for the state change.
Example:invoice overdue (30 days)
The uuid of the konger who modified the state.
Example:00uerwcs8eC4ifanR256
Response
application/json
Response
A response for setting the organization state.
Organization State
UUID of the organization.
Example:d99c041a-c7cf-46a2-bf3a-44bb5f75400e
State of the organization.
Allowed values:activeinactivedeletingdeleted
Example:active
The reason for the organization’s state.
Example:invoice overdue (30 days)
The service that modified the state.
Example:kbilling
The ID of the Konger who modified the state.
Example:00uerwcs8eC4ifanR256
Date the organization state was created.
Example:2023-01-23T17:22:52.150Z
Body
Get the state history of an organization
Returns the state history of an organization sorted in reverse chronological order.
Possible states include active, inactive, deleting, and deleted. An organization state
will be transitioned to the deleting state if the organization remains inactive for 90 days.
After deletion is complete, the state will be transitioned to the final deleted state.
Response
application/json
Response
A paginated list response for a collection of organization state changes.
Organizations State History.
returns the pagination information
Show Child Parameters
Show Child Parameters
Update Deletion Config
Sets the deletion configs for a specified organization. The retention period
is the number of days an organization can remain in the inactive state before
being permanently deleted.
Path Parameters
The ID of the organization being patched.
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Body
application/json
Body
The request schema to set an organization’s retention period.
Deletion Config
The retention period in days.
>= 1<= 365
Example:90
Response
application/json
Response
The response schema for setting an organization’s retention period.
Deletion Config
The retention period in days.
>= 1<= 365
Example:90
Path Parameters
Body
Organization State
objectUUID of the organization.
Example:d99c041a-c7cf-46a2-bf3a-44bb5f75400e
State of the organization.
Allowed values:activeinactivedeletingdeleted
Example:active
The reason for the organization’s state.
Example:invoice overdue (30 days)
The service that modified the state.
Example:kbilling
The ID of the Konger who modified the state.
Example:00uerwcs8eC4ifanR256
Date the organization state was created.
Example:2023-01-23T17:22:52.150Z