Skip to main content
PATCH
Update Organization Properties

Headers

string
required
Your API key for authentication.

Path Parameters

string
required
The unique identifier of the organization.

Body

object
required
An object containing the properties to update.


Valid keys:
  • "org_display_name" (string) - The display name of the organization. Must be between 1 and 30 characters.
  • "preferences" (object) - Preference settings for the organization:
    • "use_bland_url" (boolean) - Whether the organization prefers to use the Bland URL.
    • "recording_lifespan_days" (integer) - The lifespan of recordings in days. Must be between 1 and 1825 (inclusive) or -1 to disable retention.

Response

object
The updated organization properties.
string
The unique identifier of the organization.
string
The unique slug identifier of the organization.
string
The updated display name of the organization.
string | null
URL of the organization’s image (if set).
string
The organization’s plan. Default: "starter".
string (ISO 8601)
The timestamp of when the organization was created.
integer
The KYC (Know Your Customer) verification level. Default: 0.
string
The placement group of the organization. Default: "blandshared".
boolean
Whether the organization is deleted. Default: false.
boolean
Whether the organization has overdue Stripe payments. Default: false.
boolean
Whether the organization is suspended. Default: false.
integer
The organization’s request rate limit. Default: 5.
string
The type of the organization. Default: "normal".
array
A list of entitlements granted to the organization. Default: [].
object
The updated preferences for the organization.
boolean
Whether the organization prefers to use the Bland URL.
null
Always null on success.

Docs for agents: llms.txt