# Update the environment

<div class="api-op" data-api-operation>
<div class="api-op__main">

<p class="api-endpoint"><span class="method method-patch">PATCH</span> <code>/v1/environment</code></p>

<dl class="api-facts"><div><dt>Scope</dt><dd><code>environment:write</code></dd></div><div><dt>Auth</dt><dd>Secret key (<code>sk_…</code>)</dd></div><div><dt>Since</dt><dd>1.0</dd></div></dl>

## Headers

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">OhAuthCat-Version</code> <span class="api-field__type">string</span></p>
Minor version; defaults to the environment's pin.
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">Idempotency-Key</code> <span class="api-field__type">string</span></p>
Honoured for 24 h; a replay returns the original response.

<p class="api-field__chips">min length 1 · max length 255</p>
</li>
</ul>

## Request body

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">consent_screen_default</code> <span class="api-field__type">string</span></p>

<p class="api-field__chips">one of <code>on</code>, <code>off</code></p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">sign_in_failed_events</code> <span class="api-field__type">boolean</span></p>
Opt in to `sso.sign_in.failed` for refused sign-ins.
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">compat_workos_enabled</code> <span class="api-field__type">boolean</span></p>
Enable or disable WorkOS SSO compatibility for this environment. It remains unavailable when the deployment kill switch is off; native caller PKCE is unchanged.
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">version_pin</code> <span class="api-field__type">string</span></p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">portal_success_urls</code> <span class="api-field__type">object</span></p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">disabled_notices</code> <span class="api-field__type">array of string</span></p>
Customer-facing notices not mailed to the organizations' IT contacts (the environment's owners and admins still get them). Empty by default.

<p class="api-field__chips">max items 4</p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">portal_logo_url</code> <span class="api-field__type">string (uri) or null</span></p>
Where the setup portal's logo links (https). "" clears it.

<p class="api-field__chips">max length 2048</p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">portal_embed_origins</code> <span class="api-field__type">array of string</span></p>
The https origins (scheme and host, optional port; no path) allowed to show the setup portal in an iframe. Empty (the default) keeps embedding off. While it is set, new portal sessions use a partitioned third-party cookie (`SameSite=None; Secure; Partitioned`) so they work inside the iframe, and the portal's edge sends a `Content-Security-Policy` `frame-ancestors` directive with these origins. An empty list turns embedding off.

<p class="api-field__chips">max items 20</p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">support_email</code> <span class="api-field__type">string or null</span></p>
Customer support address shown in the setup portal and used as the reply-to of IT-contact mail. "" clears it.

<p class="api-field__chips">max length 320</p>
</li>
</ul>

## Responses

<ul class="api-responses">
<li class="api-response"><span class="api-status api-status--ok">200</span> <span>OK <span class="api-field__type">Environment</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">400</span> <span>Invalid request. Codes: <a href="/errors/parameter_invalid/">parameter_invalid</a>, <a href="/errors/parameter_missing/">parameter_missing</a>, <a href="/errors/version_unsupported/">version_unsupported</a> and resource-specific codes from the catalogue. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">401</span> <span>Codes: <a href="/errors/authentication_required/">authentication_required</a>, <a href="/errors/api_key_invalid/">api_key_invalid</a>. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">403</span> <span>Codes: <a href="/errors/api_key_scope_missing/">api_key_scope_missing</a>, <a href="/errors/ip_not_allowed/">ip_not_allowed</a>, <a href="/errors/plan_limit_reached/">plan_limit_reached</a>. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">409</span> <span>Codes: <a href="/errors/idempotency_key_reused/">idempotency_key_reused</a> and resource-specific conflicts. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">429</span> <span>Code: <a href="/errors/rate_limited/">rate_limited</a>. Retry-After is set. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">503</span> <span>Code: <a href="/errors/service_unavailable/">service_unavailable</a>. Retry-After is set; writes are paused. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--neutral">default</span> <span>Any other error, including <a href="/errors/internal_error/">internal_error</a>. Every code is in the error catalogue. <span class="api-field__type">Error</span></span></li>
</ul>

Errors share one shape; see the [error code catalogue](/errors/).

</div>
<div class="api-op__code">

**curl**

```sh wrap
curl -X PATCH \
  "https://api.ohauthcat.com/v1/environment" \
  -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "consent_screen_default": "on",
  "sign_in_failed_events": true,
  "compat_workos_enabled": true,
  "version_pin": "example_version_pin",
  "portal_success_urls": {},
  "disabled_notices": [
    "cert_expiry"
  ],
  "portal_logo_url": "https://app.acme.com/callback",
  "portal_embed_origins": [
    "example_portal_embed_origin"
  ],
  "support_email": "jane@acme.com"
}'
```

**Node**

```javascript wrap
const response = await fetch("https://api.ohauthcat.com/v1/environment", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    consent_screen_default: "on",
    sign_in_failed_events: true,
    compat_workos_enabled: true,
    version_pin: "example_version_pin",
    portal_success_urls: {},
    disabled_notices: ["cert_expiry"],
    portal_logo_url: "https://app.acme.com/callback",
    portal_embed_origins: ["example_portal_embed_origin"],
    support_email: "jane@acme.com",
  }),
});
const data = await response.json();
```

**Python**

```python wrap
import os
import requests

response = requests.patch(
    "https://api.ohauthcat.com/v1/environment",
    headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},
    json={
        "consent_screen_default": "on",
        "sign_in_failed_events": True,
        "compat_workos_enabled": True,
        "version_pin": "example_version_pin",
        "portal_success_urls": {},
        "disabled_notices": [
            "cert_expiry",
        ],
        "portal_logo_url": "https://app.acme.com/callback",
        "portal_embed_origins": [
            "example_portal_embed_origin",
        ],
        "support_email": "jane@acme.com",
    },
)
data = response.json()
```

```json title="Response 200" wrap
{
  "id": "env_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
  "object": "environment",
  "project": "proj_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
  "name": "Acme Corp",
  "type": "sandbox",
  "consent_screen_default": "on",
  "sign_in_failed_events": true,
  "gusto_oauth_available": true,
  "bamboohr_oauth_available": true,
  "google_oauth_available": true,
  "compat_workos_enabled": false,
  "version_pin": "example_version_pin",
  "home_region": "example_home_region",
  "portal_success_urls": {},
  "disabled_notices": ["cert_expiry"],
  "portal_logo_url": "https://app.acme.com/callback",
  "portal_embed_origins": ["example_portal_embed_origin"],
  "support_email": "jane@acme.com",
  "sign_ins_disabled": true,
  "sign_ins_disabled_at": "2026-01-15T09:30:00Z",
  "sign_ins_disabled_by": "customer",
  "residency": {
    "region": "eu",
    "data_classes": [
      {
        "data_class": "example_data_class",
        "description": "Primary SSO connection for Acme Corp.",
        "scope": "home_region",
        "region": "eu",
        "personal_data": true
      }
    ]
  }
}
```

</div>
</div>
