---
title: "PATCH /app/organizations/{organization_id}/"
method: PATCH
path: "/app/organizations/{organization_id}/"
tags: ["app"]
---

# PATCH /app/organizations/{organization_id}/

`PATCH /app/organizations/{organization_id}/`

A simple ViewSet for viewing and editing OrganizationSettings.

## Path parameters

- `organization_id` string, uuid, required

## Request body

- PatchedOrganizationUpdateRequest
  - `default_currency_code` string
  - `address` AddressRequest
    - `city` string, required — City, district, suburb, town, or village
    - `country` string, required — ISO 3166-1 alpha-2 country code
    - `line1` string, required — Address line 1 (e.g., street, PO Box, or company name)
    - `line2` string, nullable — Address line 2 (e.g., apartment, suite, unit, or building)
    - `postal_code` string, required — ZIP or postal code
    - `state` string, required — State, county, province, or region
  - `tax_rate` number, double, nullable — Tax rate as percentage. For example, 10.5 for 10.5%
  - `payment_grace_period` integer, nullable
  - `plan_tags` TagRequest[]
    - `tag_name` string, required
    - `tag_hex` string, nullable
    - `tag_color` string, nullable
  - `subscription_filter_keys` string[]

## Response `200`

- Organization
  - `organization_id` string, required
  - `organization_name` string, required
  - `payment_provider_ids` object, nullable
  - `users` OrganizationUser[], required
    - `username` string, required — Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
    - `email` string, email, required
    - `role` string, required
    - `status` 'Active' | 'Invited'
  - `default_currency` PricingUnit, required
    - `code` string, required
    - `name` string, required
    - `symbol` string, required
  - `available_currencies` PricingUnit[], required
    - `code` string, required
    - `name` string, required
    - `symbol` string, required
  - `plan_tags` Tag[], required
    - `tag_name` string, required
    - `tag_hex` string, nullable
    - `tag_color` string, nullable
  - `tax_rate` number, double, nullable — Tax rate as percentage. For example, 10.5 for 10.5%
  - `payment_grace_period` integer, nullable, required
  - `linked_organizations` LightweightOrganization[], required
    - `organization_id` string, required
    - `organization_name` string, required
    - `organization_type` 'Production' | 'Development' | 'Demo' | 'Internal Demo', required
    - `current` boolean, required
  - `current_user` LightweightUser, required
    - `username` string, required — Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
    - `email` string, email, required
  - `address` Address, required
    - `city` string, required — City, district, suburb, town, or village
    - `country` string, required — ISO 3166-1 alpha-2 country code
    - `line1` string, required — Address line 1 (e.g., street, PO Box, or company name)
    - `line2` string, nullable — Address line 2 (e.g., apartment, suite, unit, or building)
    - `postal_code` string, required — ZIP or postal code
    - `state` string, required — State, county, province, or region
  - `team_name` string, required
  - `subscription_filter_keys` string[], required

## Changes

- **2023-01-16** `36b48cae00a3` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/uselotus/apis/lotus-api/changes/app/organizations/:organization_id/patch.md)

---

[API](https://skmtc.dev/uselotus/apis/lotus-api.md) · [All operations](https://skmtc.dev/uselotus/apis/lotus-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/uselotus/lotus-api/revisions/36b48cae00a3/schema)