1. OpenAPI (Demo)
  2. Organizations
  3. Update an organization
ReadmeGitHub
  • Platform API overview
  • Quickstart
  • POSTCreate a member session
  • POSTRefresh a member session
  • DELETERevoke a member session
  • GETList organizations
  • POSTCreate an organization
  • GETGet an organization
  • PATCHUpdate an organization
  • GETList organization members
  • POSTInvite an organization member
  • DELETERemove an organization member
  • PATCHUpdate a member role
  • GETList projects
  • POSTCreate a project
  • GETGet a project
  • DELETEArchive a project
  • PATCHUpdate a project
  • GETList project environments
  • POSTCreate a project environment
  • GETList project documents
  • POSTCreate a project document
  • GETGet a document
  • DELETEArchive a document
  • PATCHUpdate a document
  • POSTPublish a document
  • GETList contacts
  • POSTCreate a contact
  • GETGet a contact
  • DELETEDelete a contact
  • PATCHUpdate a contact
  • GETList product events
  • GETGet analytics overview
  • GETList workflows
  • POSTCreate a workflow
  • GETList workflow runs
  • GETList webhook subscriptions
  • POSTCreate a webhook subscription
  • GETGet a webhook subscription
  • DELETEDelete a webhook subscription
  • PATCHUpdate a webhook subscription
  • GETList webhook deliveries
  • POSTReplay a webhook delivery
  • GETList files
  • POSTCreate a multipart file upload
  • GETGet file metadata
  • DELETEDelete a file
  • GETGet current subscription
  • PATCHUpdate subscription settings
  • GETList invoices
  • GETGet metered usage
  • GETList API keys
  • POSTCreate an API key
  • POSTRevoke an API key
  • GETList audit logs
  • GETList exports
  • POSTCreate an export
  • GETGet API health
PATCH/organizations/{organizationId}

Update an organization

Updates editable organization properties. Send the current ETag to avoid replacing a newer change.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL
Bearer tokenBearerAuthoptional
Stored only in this browser for the BearerAuth security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

organizationIdpath · stringrequired

Opaque organization identifier.

If-Matchheader · stringoptional

Current resource ETag for optimistic concurrency.

Request body

application/jsonrequired
namestringoptional
timezonestringoptional
settingsobjectoptional

Responses

200application/json

Organization updated.

{
  "id": "org_01J8F1Q6N6VTX4E8W9R2D0A7B3",
  "name": "Northstar Labs",
  "slug": "northstar-labs",
  "plan": "enterprise",
  "timezone": "Europe/Warsaw",
  "member_count": 42,
  "limits": {
    "projects": 100,
    "api_requests_per_minute": 5000
  },
  "etag": "W/\"org-204\"",
  "created_at": "2025-01-12T09:15:00Z",
  "updated_at": "2026-09-03T10:20:00Z"
}
idstringoptional
namestringoptional
slugstringoptional
planstringoptional
timezonestringoptional
member_countintegeroptional
limitsobjectoptional
etagstringoptional
created_atstring · date-timeoptional
updated_atstring · date-timeoptional
409application/json

ETag does not match the latest organization.

{
  "error": {
    "code": "validation_failed",
    "message": "One or more fields need attention.",
    "details": [
      {
        "path": "name",
        "code": "too_short",
        "message": "Use at least 3 characters."
      }
    ]
  },
  "request_id": "req_01J8F6C4YTP8B2S9QK1M"
}
errorrequired
request_idstringrequired
Get an organization< PreviousList organization membersNext >

Powered by heyo

curl --request PATCH \  'https://api.demo.heyo.example/v3/organizations/org_01J8F1Q6N6VTX4E8W9R2D0A7B3' \  --header 'If-Match: W/"org-204"' \  --header 'Content-Type: application/json' \  --data '{  "name": "Northstar Labs Europe",  "timezone": "Europe/Warsaw",  "settings": {    "week_starts_on": "monday",    "allow_public_exports": false  }}'
{  "id": "org_01J8F1Q6N6VTX4E8W9R2D0A7B3",  "name": "Northstar Labs",  "slug": "northstar-labs",  "plan": "enterprise",  "timezone": "Europe/Warsaw",  "member_count": 42,  "limits": {    "projects": 100,    "api_requests_per_minute": 5000  },  "etag": "W/\"org-204\"",  "created_at": "2025-01-12T09:15:00Z",  "updated_at": "2026-09-03T10:20:00Z"}