v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB

Organizations

Update Organization

Update organization settings (requires ADMIN permission).

Security: Infrastructure configuration cannot be modified via this endpoint. Infrastructure updates require Mixpeek admin access via private endpoints.

patch/v1/organizations

Request body

organization_namestring nullable

Updated display name for the organization.

logo_urlstring nullable

Updated organization logo URL (e.g., custom logo to override auto-generated logo).

billing_emailstring email nullable

Updated billing contact email.

notifications_emailstring email nullable

Set the opt-in single address that receives alert/system notifications (None leaves it unchanged via exclude_unset).

metadataobject nullable

Replace metadata with provided dictionary when set.

default_llm_credentialsobject nullable

Map of provider names to secret names for org-wide LLM credentials.

nsfw_check_enabledboolean nullable

Toggle NSFW upload classification + hard-reject for this organization. Applies only to SHARED-plane tenants (infrastructure is None). None leaves the current setting unchanged.

nsfw_fail_closedboolean nullable

Toggle fail-closed behaviour for the NSFW gate (reject uploads when the classifier is unavailable instead of allowing them). None leaves the current setting unchanged.

Example request

{
  "rate_limit_overrides": {
    "metadata": 20,
    "data": 10,
    "search": 10,
    "upload": 5,
    "compute": 5
  }
}

Response

Successful Response

organization_idstring required

organization_namestring required

logo_urlstring nullable

Account tier (2026-07 pricing overhaul).

Current tiers (CC-required, tier minimum is a billing floor): BUILD: $25/mo min — 100K objects/mo (managed) / 1M vectors (MVS) SCALE: $250/mo min — 1M objects/mo (managed) / 25M vectors (MVS) ENTERPRISE: Custom — dedicated compute, SLA

LEGACY tiers — still stored on unmigrated orgs; resolvable until the Phase-4 migration completes (do NOT remove before then — org records in Mongo carry these strings): FREE (→ Build or read-only), PRO (→ Build), TEAM (→ Scale)

credit_countinteger required

effective_monthly_credit_capinteger nullable

onboarding_answersobject nullable

metadataobject

billing_emailstring email nullable

notifications_emailstring email nullable

auto_billing_enabledboolean

billing_cycle_startinteger

current_month_usageinteger

created_atstring date-time required

updated_atstring date-time required

usersobject[] nullable

auth_provider_org_idstring nullable

default_llm_credentialsobject

api_urlstring nullable

requires_planboolean

True when this workspace must pick a plan before it can create namespaces or run billable work. When gated, write endpoints return 403 PlanRequiredError with a link to https://studio.mixpeek.com/signup/plan.

Example response

{
  "account_type": "pro",
  "created_at": "2025-01-01T00:00:00Z",
  "credit_count": 250000,
  "logo_url": "https://www.google.com/s2/favicons?domain=acme.com&sz=128",
  "organization_id": "org_demo123",
  "organization_name": "Acme Corporation"
}