## Update Organization

`$ nirvana organizations update`

**patch** `/v1/organizations/{organization_id}`

Update an existing organization

### Parameters

- `--organization-id: string`

  Organization ID

- `--billing-email: optional string`

  Billing email. Omit to leave unchanged, send null to clear (reverts to the
  oldest owner's email), or send a value to set it.

- `--name: optional string`

  Organization name.

### Returns

- `organization: object { id, billing_email, created_at, 9 more }`

  Organization response.

  - `id: string`

    Organization ID.

  - `billing_email: string`

    Billing email. Null when no custom billing email is set (reverts to the oldest owner's email).

  - `created_at: string`

    When the Organization was created.

  - `domains: array of OrganizationDomain`

    Domains associated with the organization.

    - `id: string`

      Domain ID.

    - `domain: string`

      Domain name.

    - `verified: boolean`

      Whether the domain has been verified.

  - `metronome_customer_id: string`

    Metronome customer ID.

  - `name: string`

    Organization name.

  - `personal: boolean`

    Whether the organization is a personal Organization.

  - `services: object { cloud, jit_provisioning, scim, 2 more }`

    Services that the Organization has access to.

    - `cloud: boolean`

      Whether cloud services are enabled for the organization.

    - `jit_provisioning: boolean`

      Whether just-in-time provisioning is enabled for the organization.

    - `scim: boolean`

      Whether SCIM provisioning is enabled for the organization.

    - `siem: boolean`

      Whether SIEM integration is enabled for the organization.

    - `sso: boolean`

      Whether single sign-on is enabled for the organization.

  - `stripe_customer_id: string`

    Stripe customer ID.

  - `type: "personal" or "company"`

    Organization type.

    - `"personal"`

    - `"company"`

  - `updated_at: string`

    When the Organization was updated.

  - `auth_id: optional string`

    Authentication provider organization ID.

### Example

```cli
nirvana organizations update \
  --api-key 'My API Key' \
  --organization-id organization_id
```

#### Response

```json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "billing_email": "billing@example.com",
  "created_at": "2025-01-01T00:00:00Z",
  "domains": [
    {
      "id": "456e7890-e89b-12d3-a456-426614174000",
      "domain": "example.com",
      "verified": true
    }
  ],
  "metronome_customer_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "My Organization",
  "personal": false,
  "services": {
    "cloud": true,
    "jit_provisioning": true,
    "scim": false,
    "siem": false,
    "sso": false
  },
  "stripe_customer_id": "cus_1234567890",
  "type": "company",
  "updated_at": "2025-01-01T00:00:00Z",
  "auth_id": "org_01H8GQBX3Z"
}
```