organizations

Patch Org

Changed on
patch/api/v1/orgs/{org_id}

Request

  • Base URL
    https://cp.xenovia.io (the document declares no server; this is the origin it was published from)
  • URL
    https://cp.xenovia.io/api/v1/orgs/{org_id}
  • Auth
    none declared

Path parameters

org_idstring required

Headers

Authorizationstring nullable

Request body

onboarding_action'start' | 'skip' | 'use_console' required

Response

Successful Response

idstring uuid required
created_atstring date-time required
updated_atstring date-time required
namestring required
slugstring required
clerk_org_idstring required
plan'free' | 'pro' | 'enterprise' required
status'pending' | 'active' | 'suspended' | 'deleted' required
entitlementsobject
featuresobject
viewer_product_tour_eligibleboolean required

Changes

  • 3e25bef24f8fRevision changes
    • warning

      added the new connect enum value to the // response property for the response status

    • warning

      added the new discover enum value to the // response property for the response status

    • warning

      added the new govern enum value to the // response property for the response status

    • info

      added the new use_console enum value to the request property

    • info

      added the optional property / to the response with the status

  • 38e8e6901817Revision changes
    • info

      added the optional property to the response with the status