org.update

Requires organization administrator rights.

TR50 Request

{
  "cmd": {
    "command": "org.update",
    "params": {
      "key": "SYSTEM",
      "profile": "52a1d3db169e1fd032179409"
    }
  }
}


Name	Type	Description
key	String	The key of the organization to update. If not specified, the organization associated with the session that initiated the request will be used.
name	String	The name of the organization.
profile	String	The org profile for the organization.
desc	String	The description of the organization.
locale	String	The default locale of the organization.
domain	String	The domain to claim (e.g. example.com). Must be unique among all orgs. Requires super-ops rights.
customerRefId	String	The customer reference identifier.
allowSubOrgs	Boolean	Whether this organization will allow child organizations to be attached to it.
apiRateLimit	Integer	The API rate limit for the organization in calls per second. Can only be set by a super-ops.
suspended	Boolean	Whether this organization is suspended. Can only be set by a super-admin.
suspendedReason	String	The reason displayed if the organization is suspended, optionally. Can only be set by a super-admin.
data	Object	Opaque data store object with valid keys. If provided, overwrites the existing data object.

If the command is sent successfully a success message is returned. Otherwise, an error and error message are returned.

{
  "cmd": {
    "success": true
  }
}