Skip to content
deedglassdocs

Change the org's name, time zone, payload retention or approval settings

PATCH
/v1/org
curl --request PATCH \
  --url http://127.0.0.1:8080/v1/org \
  --header 'Content-Type: application/json' \
  --header 'Deedglass-CSRF: example' \
  --header 'Deedglass-Version: 2026-10-01' \
  --cookie __Host-deedglass_session=<__Host-deedglass_session> \
  --data '{ "timezone": "Asia/Kolkata" }'

Admins and owners change name and timezone; only an owner may send retention_days or settings (an admin gets 403 insufficient_role). Only the fields and keys sent change; settings.approvals is merged into the stored settings. Seals one org.updated admin deed when something changed (data: fields, timezone, and the new retention_days and approvals when sent), none otherwise. Needs the Deedglass-CSRF header.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Deedglass-Version
string
/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/

The API version (YYYY-MM-DD). Leave it out to use your org’s pinned version (public routes use the latest). An unknown version is 400 api_version_invalid.

Deedglass-CSRF
required
string

The CSRF token from GET /v1/me (it equals the __Host-deedglass_csrf cookie). Every session request that changes state needs it; without it the answer is 403 csrf_failed.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
string
>= 1 characters <= 100 characters
timezone

An IANA time zone name such as Asia/Kolkata.

string
retention_days

Owner only (S26). Days to keep action payloads; null goes back to the default of 90.

integer | null
>= 1 <= 3650
settings

Owner only (S26). Unknown keys are 400 validation_failed with their path as param.

object
approvals
object
email_links
string
Allowed values: decide review
email_detail
string
Allowed values: summary full
self_countersign
string
Allowed values: deny allow
Example
{
  "timezone": "Asia/Kolkata"
}

Responses

Section titled “Responses”

200

Section titled “200”

The org, with the deed (null when nothing changed).

Media typeapplication/json
object
object
required
string
Allowed value: org
id
required
string
name
required
string
slug
required
string
timezone
required
string
status
required
string
Allowed values: active disabled
created_at
required
string format: date-time
retention_days

GET and PATCH /v1/org only (S26, additive): how many days action payloads are kept, the org’s setting or the default of 90. Omitted elsewhere.

integer
>= 1 <= 3650
settings

GET and PATCH /v1/org only (S26, additive), with defaults applied. Omitted elsewhere.

object
approvals
required
object
email_links
required

Whether emailed approval links can decide (default) or only open the review page.

string
Allowed values: decide review
email_detail
required

How much of the request approval emails show (default summary).

string
Allowed values: summary full
self_countersign
required

Whether the person an action runs on behalf of may countersign it (default deny).

string
Allowed values: deny allow
simulated

Read only (S29, additive): present and true when the org was made by deedglass dev simulate; omitted otherwise. PATCH /v1/org refuses it.

boolean
stop

GET /v1/org only (additive): the Stop all overlay, which the Console’s org-stopped banner reads. Omitted elsewhere.

object
stopped
required
boolean
stopped_at
required
string | null format: date-time
stopped_by
required

Who turned it on.

string | null
reason
required
string | null
deed
required
string | null
Example
{
  "object": "org",
  "status": "active",
  "settings": {
    "approvals": {
      "email_links": "decide",
      "email_detail": "summary",
      "self_countersign": "deny"
    },
    "simulated": true
  }
}

default

Section titled “default”

An error. Every error has this envelope; doc_url explains the code.

Media typeapplication/json
object
error
required
object
type
required
string
Allowed values: invalid_request_error authentication_error permission_error policy_error rate_limit_error api_error
code
required
string
Allowed values: invalid_api_key api_key_revoked api_key_expired agent_suspended agent_stopped org_stopped insufficient_scope policy_denied approval_required approval_expired budget_exceeded intent_required intent_invalid intent_replay tool_unknown connector_unavailable upstream_error timeout rate_limited idempotency_conflict validation_failed not_found conflict internal_error authentication_required method_not_allowed request_too_large unsupported_media_type invalid_json api_version_invalid idempotency_key_invalid idempotency_key_in_use service_unavailable session_expired csrf_failed insufficient_role login_link_invalid login_code_invalid last_owner policy_unavailable policy_invalid credentials_missing destination_blocked vault_unavailable upstream_auth_failed upstream_not_found upstream_rate_limited response_too_large statement_refused row_limit_exceeded database_role_unsafe database_not_ready witness_not_configured approval_decided already_countersigned approver_not_eligible self_approval approval_needs_person context_changed approval_unsatisfiable approval_link_invalid approval_link_review_only approver_unmapped stripe_live_key_refused stripe_livemode_detected upstream_approval_pending schedule_needs_approval action_executing from_denied undo_unavailable undo_plan_stale already_undone undo_conflict replay_too_large replay_window_invalid suggestion_stale shadow_slot_taken suggestion_decided observe_not_enabled pro_required
message
required

One or more calm sentences with the next step.

string
param
required

The request field, query parameter or header the error is about.

string | null
request_id
required
string
/^req_[0-7][0-9a-hjkmnp-tv-z]{25}$/
doc_url
required
string format: uri
diagnostics

On policy_invalid only. Each problem with its line, code and hint.

Array<object>

One finding about a policy file, with its position and the next step. Codes are stable and listed in docs/POLICY_ERRORS.md. In the policy_invalid error envelope each diagnostic also carries object: policy_diagnostic. The full PolicyDiagnostic schema is in openapi.yaml.

object
action

One agent action. Its sections mirror the deed’s. status is the one field an agent needs; state is the exact lifecycle state (docs/GATE.md). The Gate’s own responses (POST /v1/actions and its result report) add execution.result and witness.reasons; lists leave both out. The full Action schema is in openapi.yaml.

object
checks

On undo_unavailable only. Every check of the undo, each with its fix. Additive (S23).

Array<object>

One of the twelve safety checks (S23 §3.3). Available means no check failed. The full UndoCheck schema is in openapi.yaml.

object
Example
{
  "error": {
    "type": "invalid_request_error",
    "code": "not_found",
    "message": "There's no endpoint at GET /v1/helth. Did you mean /v1/health?",
    "param": null,
    "request_id": "req_01j9zr3m5k8q2w7x4t6v0b1c9d",
    "doc_url": "https://docs.deedglass.com/errors/not_found"
  }
}

Headers

Section titled “Headers”
Deedglass-Request-Id
string
/^req_[0-7][0-9a-hjkmnp-tv-z]{25}$/

This request’s id. Quote it to support; it matches error.request_id.

Deedglass-Version
string

The API version this response follows.