Organizations

Update an organization

Sets an organization's status, its name, or both.

SUSPENDED refuses sign-ins to the organization and refuses member changes through this API. A member whose only organization this is has their existing sessions ended as well; one who also belongs elsewhere keeps their session for those organizations and is refused this one. Restoring does not restore a session that was ended — those people sign in again.

Reads stay available while suspended, so a billing period that ends after the suspension can still be reconciled. Renaming is also still allowed.

Requires the organizations:write partner scope.

patch/v2/organizations/{external_org_id}/

Request

  • Base URL: https://api.outset.ai
  • URL: https://api.outset.ai/v2/organizations/{external_org_id}/
  • Auth: HTTP bearer

Path parameters

external_org_idstring required

Request body

status'ACTIVE' | 'SUSPENDED'
  • ACTIVE - ACTIVE
  • SUSPENDED - SUSPENDED
namestring

Rename the organization — the name its members see, not your own identifier for it, which is fixed at creation. Your provider name is appended automatically, so the value you send is a prefix rather than the final name. Organization names are unique across Outset, so a name already taken within your estate is rejected.

Response

Changes

No recorded changes to this operation across all 1 revision of this API.