---
title: "Update an Organization"
method: PUT
path: "/orgs/{org_id}"
tags: ["Organizations"]
---

# Update an Organization

`PUT /orgs/{org_id}`

## Request

- Base URL: `https://dataops.nexla.io/nexla-api`
- URL: `https://dataops.nexla.io/nexla-api/orgs/{org_id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/nexla/apis/nexla-rest-api/docs/orgs/:org_id/put.ts> (a function with typed inputs; its response is checked against the schema)

Updates properties of an organization.

## Path parameters

- `org_id` integer, required

## Request body

- OrgsUpdate
  - `name` string
  - `owner_id` integer
  - `billing_owner_id` integer
  - `email_domain` string
  - `client_identifier` string: Recommended but not required. This is a unique identifier for the organization in the environment. This identifier is especially useful for organizations that are using SSO. Recommendation: Use the organization's domain name. Apply variants if a company needs more than one organization account in the environment.
  - `enable_nexla_password_login` boolean: Set to `false` if an organization requires no user to be allowed username-password-based access. Applicable for organizations who use GSuite email or have SSO enabled. Default value: `true`
  - `custodians` object[]
    - `id` integer
    - `email` string

## Response `200`

Success

- object
  - `id` integer
  - `name` string
  - `description` unknown
  - `cluster_id` integer
  - `new_cluster_id` unknown
  - `cluster_status` string
  - `email_domain` string
  - `email` unknown
  - `client_identifier` string
  - `org_webhook_host` string, url
  - `access_roles` string[]: This property reflects all the permissions the user/team/organization has to this resource. 1. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. 2. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. 3. `administrator`: The user/team/organization has complete administrative rights to this resource. 4. `owner`: This user created the resource and so has complete administrative rights to it.
  - `owner` object
    - `id` integer
    - `email` string, email
    - `full_name` string
    - `impersonated` boolean
    - `default_org` object
      - `id` integer
      - `name` string
    - `user_tier` unknown
    - `status` string
    - `account_locked` boolean
    - `org_memberships` object[]
      - `id` integer
      - `name` string
      - `is_admin?` boolean
      - `org_membership_status` string
    - `email_verified_at` string, date-time
    - `tos_signed_at` unknown
    - `updated_at` string, date-time
    - `created_at` string, date-time
  - `billing_owner` object
    - `id` integer
    - `email` string, email
    - `full_name` string
    - `impersonated` boolean
    - `default_org` object
      - `id` integer
      - `name` string
    - `user_tier` unknown
    - `status` string
    - `account_locked` boolean
    - `org_memberships` object[]
      - `id` integer
      - `name` string
      - `is_admin?` boolean
      - `org_membership_status` string
    - `email_verified_at` string, date-time
    - `tos_signed_at` unknown
    - `updated_at` string, date-time
    - `created_at` string, date-time
  - `admins` object[]
    - `id` integer
    - `full_name` string
    - `email` string, email
  - `org_tier` object
    - `id` integer
    - `name` string
    - `display_name` string
    - `record_count_limit` integer
    - `record_count_limit_time` string
    - `data_source_count_limit` integer
    - `trial_period_days` integer
  - `members_default_access_role` string
  - `status` string
  - `default_reusable_code_container_access_role` string
  - `require_org_admin_to_publish` boolean
  - `require_org_admin_to_subscribe` boolean
  - `email_domain_verified_at` unknown
  - `name_verified_at` unknown
  - `enable_nexla_password_login` boolean
  - `updated_at` string, date-time
  - `created_at` string, date-time

## Other responses

- `403`: Forbidden

---

[API](https://skmtc.dev/nexla/apis/nexla-rest-api.md) - [All operations](https://skmtc.dev/nexla/apis/nexla-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nexla/apis/nexla-rest-api/revisions/ef02be92fe7b?raw)