v4

latestOpenAPI 3.1.1Apache 2.02026-07-31107278570.4 KB

Organizations

Update organization details

Updates an organization's display name, external ID, or metadata. Requires a valid organization identifier. Region code cannot be modified through this endpoint.

patch/api/v1/organizations/{id}

Path parameters

idstring required

Unique identifier of the organization to be updated

Request body

display_namestring

Name of the organization to display in the UI. Must be between 1 and 200 characters

external_idstring

Your application's unique identifier for this organization, used to link Scalekit with your system

logo_urlstring uri

HTTPS URL of the organization's logo image. Maximum 1024 characters. Must use the https scheme.

metadataobject

Custom key-value pairs to store with the organization. Keys must be 3-25 characters, values must be 1-256 characters. Maximum 10 pairs allowed.

slugstring

Slug for dynamic redirect URI resolution. A single DNS label (e.g. acme) or hostname (e.g. oauth.pstmn.io). Lowercase alphanumeric, hyphens, and dots. Max 253 chars. Send empty string to clear.

Example request

{
  "display_name": "Acme Corporation",
  "external_id": "tenant_12345",
  "logo_url": "https://cdn.example.com/acme-logo.png",
  "metadata": {
    "industry": "technology"
  },
  "slug": "acme"
}

Response

Returns the updated organization with all current details reflected in the response.

Example response

{
  "organization": {
    "create_time": "2025-02-15T06:23:44.560000Z",
    "display_name": "Megasoft",
    "external_id": "my_unique_id",
    "id": "org_59615193906282635",
    "logo_url": "https://cdn.example.com/acme-logo.png",
    "settings": {
      "features": [
        {
          "enabled": true,
          "name": "sso"
        },
        {
          "enabled": false,
          "name": "directory_sync"
        }
      ]
    },
    "slug": "acme",
    "update_time": "2025-02-15T06:23:44.560000Z"
  }
}