Skip to main content

​
PATCH /api/v1/organizations/

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

​
Request

​
Path Parameters

​
id
string
required
Unique identifier of the organization to be updated.
org_59615193906282635

​
Body Parameters

​
display_name
string
Name of the organization to display in the UI. Must be between 1 and 200 characters.
Acme Corporation
​
external_id
string
Your application’s unique identifier for this organization, used to link Scalekit with your system.
tenant_12345
​
metadata
object
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.
{
  "industry": "technology",
  "plan": "enterprise"
}

​
Response

​
organization
object
The updated organization with all current details reflected in the response.

​
Examples

    Build docs developers (and LLMs) love

    Get started for freeTalk to us