Skip to navigation
API ReferenceOrganization

Update Organization

Updates an organization’s configuration.

🚧 Requires partner key

This endpoint is only accessible using partner keys.

📘 Credential scope varies by endpoint and API version

Organization endpoints do not all share the same credential requirements. Check each endpoint’s description for the caller scope that applies in that API version.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

OR
AuthorizationBearer
This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"
Unique identifier of the organization to update.

Headers

X-Polytomic-VersionstringRequired

Request

This endpoint expects an object.
namestringRequired

Human-readable name of the organization. Must be unique across the partner account.

client_idstringOptional
OIDC client ID issued by the identity provider.
client_secretstringOptional

OIDC client secret issued by the identity provider. Write-only; never returned in responses.

issuerstringOptional

OIDC issuer URL for organizations using OpenID Connect single sign-on.

sso_domainstringOptional

Email domain used to match users to this organization during SSO sign-in.

sso_org_idstringOptional

WorkOS organization identifier linking this organization to its SAML/SSO configuration.

Response

OK
dataobjectOptional

Errors

401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
422
Unprocessable Entity Error
500
Internal Server Error