A newer version is available. For the latest information, see the
current release documentation.
Update organizationedit
This endpoint is deprecated and scheduled to be removed in the next major version.
Updates an existing organization. Currently unavailable in self-hosted ECE.
Requestedit
PUT /api/v1/organizations/{organization_id}
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the Organization |
Request bodyedit
(OrganizationRequest
) (required) The organization to update
Responsesedit
-
200
-
Organization updated successfully
-
400
-
-
Name must be between 2 and 30 characters. (code:
organization.invalid_name
) -
User already has an organization. (code:
organization.user_organization_already_exists
)
Headers
-
x-cloud-error-codes
(string
; allowed values: [organization.invalid_name
,organization.user_organization_already_exists
]) - The error codes associated with the response
-
Name must be between 2 and 30 characters. (code:
-
401
-
You are not authorized to perform this action
-
403
-
The current user does not have access to the requested organization. (code:
organization.invalid_access
)Headers
-
x-cloud-error-codes
(string
; allowed values: [organization.invalid_access
]) - The error codes associated with the response
-
-
404
-
Organization not found. (code:
organization.not_found
)Headers
-
x-cloud-error-codes
(string
; allowed values: [organization.not_found
]) - The error codes associated with the response
-
Request exampleedit
curl -XPUT https://{{hostname}}/api/v1/organizations/{organization_id} \ -H "Authorization: ApiKey $ECE_API_KEY" \ -H 'Content-Type: application/json' \ -d ' { "default_disk_usage_alerts_enabled" : true, "name" : "string", "notifications_allowed_email_domains" : [ "string" ] } '