For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inBook a demo
GuidesAPI Reference
GuidesAPI Reference
  • API Reference
      • GETGet Current Organization
      • GETGet Organizations
      • POSTCreate Organization
      • GETGet Organization
      • PUTUpdate Organization
      • DELDelete Organization
Logo
Log inBook a demo
API ReferenceOrganization

Update Organization

PUT
https://app.polytomic.com/api/organizations/:id
PUT
/api/organizations/:id
$curl -X PUT https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "name": "My Organization"
>}'
1{
2  "data": {
3    "id": "string",
4    "issuer": "https://example.com",
5    "name": "My Organization",
6    "sso_domain": "example.com",
7    "sso_org_id": "123456"
8  }
9}
Updates an organization's name and SSO or OIDC configuration. > 🚧 Requires partner key > > This endpoint is only accessible using [partner keys](../../../guides/obtaining-api-keys#partner-keys). > 📘 SSO and OIDC configuration is replaced in full on each update. Include all > desired settings in the request body, not just the fields you want to change.
Was this page helpful?
Previous

Delete Organization

Next

Updates an organization’s name and SSO or OIDC configuration.

🚧 Requires partner key

This endpoint is only accessible using partner keys.

📘 SSO and OIDC configuration is replaced in full on each update. Include all desired settings in the request body, not just the fields you want to change.

Authentication

AuthorizationBearer
Bearer partner API key

Path parameters

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

Headers

X-Polytomic-VersionstringOptional

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
dataobject

Errors

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