PATCH
/
v1
/
orgs
/
{org_id}
/
properties
Update Organization Properties
curl --request PATCH \
  --url https://api.bland.ai/v1/orgs/{org_id}/properties \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '{
  "updates": {}
}'
{
  "data": {
    "id": "d122b4cf-1614-4124-aa28-15f81a09988f",
    "org_slug": "133906ea-d750-4a15-80fa-d6aef584dc58",
    "org_display_name": "Org Name",
    "org_image_url": null,
    "org_plan": "starter",
    "org_creation_date": "2025-02-14T06:46:09.818Z",
    "kyc_level": 0,
    "placement_group": "blandshared",
    "is_deleted": false,
    "is_stripe_overdue": false,
    "is_suspended": false,
    "org_rate_limit": 5,
    "org_type": "normal",
    "entitlements": [],
    "preferences": {
      "use_bland_url": false
    }
  },
  "errors": null
}

​
Headers

​
authorization
string
required

Your API key for authentication.

​
Path Parameters

​
org_id
string
required

The unique identifier of the organization.

​
Body

​
updates
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

​
data
object

The updated organization properties.

​
data.id
string

The unique identifier of the organization.

​
data.org_slug
string

The unique slug identifier of the organization.

​
data.org_display_name
string

The updated display name of the organization.

​
data.org_image_url
string | null

URL of the organization’s image (if set).

​
data.org_plan
string

The organization’s plan. Default: "starter".

​
data.org_creation_date
string (ISO 8601)

The timestamp of when the organization was created.

​
data.kyc_level
integer

The KYC (Know Your Customer) verification level. Default: 0.

​
data.placement_group
string

The placement group of the organization. Default: "blandshared".

​
data.is_deleted
boolean

Whether the organization is deleted. Default: false.

​
data.is_stripe_overdue
boolean

Whether the organization has overdue Stripe payments. Default: false.

​
data.is_suspended
boolean

Whether the organization is suspended. Default: false.

​
data.org_rate_limit
integer

The organization’s request rate limit. Default: 5.

​
data.org_type
string

The type of the organization. Default: "normal".

​
data.entitlements
array

A list of entitlements granted to the organization. Default: [].

​
data.preferences
object

The updated preferences for the organization.

​
data.preferences.use_bland_url
boolean

Whether the organization prefers to use the Bland URL.

​
errors
null

Always null on success.

{
  "data": {
    "id": "d122b4cf-1614-4124-aa28-15f81a09988f",
    "org_slug": "133906ea-d750-4a15-80fa-d6aef584dc58",
    "org_display_name": "Org Name",
    "org_image_url": null,
    "org_plan": "starter",
    "org_creation_date": "2025-02-14T06:46:09.818Z",
    "kyc_level": 0,
    "placement_group": "blandshared",
    "is_deleted": false,
    "is_stripe_overdue": false,
    "is_suspended": false,
    "org_rate_limit": 5,
    "org_type": "normal",
    "entitlements": [],
    "preferences": {
      "use_bland_url": false
    }
  },
  "errors": null
}