Update organization

PUT /organizations/{organization_id}

WARNING This endpoint is deprecated and scheduled to be removed in the next major version.

Updates an existing organization. Currently unavailable in self-hosted ECE.

Path parameters

  • organization_id string Required

    Identifier for the Organization

application/json

Body Required

The organization to update

  • name string

    The organization's friendly name

  • default_disk_usage_alerts_enabled boolean

    Whether the default disk alerts are enabled

  • notifications_allowed_email_domains array[string]

    The list of allowed domains for notification-email recipients

  • billing_contacts array[string]

    The list of contacts for billing notifications

  • operational_contacts array[string]

    The list of contacts for operational notifications

Responses

  • 200 application/json

    Organization updated successfully

    Hide response attributes Show response attributes object
    • id string Required

      The organization's identifier

    • name string Required

      The organization's friendly name

    • default_disk_usage_alerts_enabled boolean

      Whether the default disk alerts are enabled

    • notifications_allowed_email_domains array[string]

      The list of allowed domains for notification-email recipients

    • billing_contacts array[string]

      The list of contacts for billing notifications, if specified

    • operational_contacts array[string]

      The list of contacts for operational notifications, if specified

    • sso_login_identifier string

      The login identifier for initiating SSO

  • 400 application/json
    • Name must be between 2 and 30 characters. (code: organization.invalid_name)
    • User already has an organization. (code: organization.user_organization_already_exists)
    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Values are organization.invalid_name or organization.user_organization_already_exists.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

  • 401 application/json

    You are not authorized to perform this action

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

  • 403 application/json

    The current user does not have access to the requested organization. (code: organization.invalid_access)

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is organization.invalid_access.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

  • 404 application/json

    Organization not found. (code: organization.not_found)

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is organization.not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

PUT /organizations/{organization_id}
curl \
 --request PUT 'https://api.elastic-cloud.com/api/v1/organizations/{organization_id}' \
 --header "Content-Type: application/json" \
 --data '{"name":"string","default_disk_usage_alerts_enabled":true,"notifications_allowed_email_domains":["string"],"billing_contacts":["string"],"operational_contacts":["string"]}'