Docs

API reference · Organizations

Rename an organization

PATCH/v1/orgs/{org}
Permission
org.organization.update
Audit log
org.organization.update
Operation
org.organizations.update

Parameters

NameInTypeRequiredNotes
orgpathstringyesfor example "org_01h455vb4pex5vsknk084sn02q"
Idempotency-KeyheaderstringnoOne key per intended mutation. A retry with the key replays the recorded response instead of executing again; the key with another request answers 422 idempotency_key_reused. For example "01h455vb4pex5vsknk084sn02q"
x-obhut-management-assignmentheaderstringnoSelect one staff assignment. Direct membership remains the default. Bound API tokens use their stored source and ignore this selector. For example "masg_01h455vb4pex5vsknk084sn02q"

Request body

FieldTypeRequiredNotes
namestringyes1 to 100 characters

Response 200

FieldTypeRequiredNotes
idstringyesfor example "org_01h455vb4pex5vsknk084sn02q"
namestringyes1 to 100 characters
createdAtstring (date-time)yesUTC, ISO 8601.
suspensionobject or nullyes
suspension.sincestring (date-time)yesUTC, ISO 8601.
suspension.reasonstringyes