Skip to main content
PATCH
/
orgs
/
{org_id}
/
orgs
/
{sub_org_id}
Update Sub-Organization
curl --request PATCH \
  --url https://api.useinvent.com/orgs/{org_id}/orgs/{sub_org_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "logo_id": "<string>",
  "config": {
    "email": "jsmith@example.com",
    "address": "<string>",
    "terms_url": "<string>",
    "privacy_url": "<string>",
    "access": {
      "session_ttl_seconds": 0,
      "allow_google": true,
      "allow_email_code": true,
      "allow_invites": true
    },
    "modules": {
      "enable_inbox": true,
      "enable_analytics": true,
      "enable_boards": true,
      "enable_assistants": true,
      "enable_knowledge_base": true,
      "enable_broadcasts": true,
      "enable_workflows": true,
      "enable_audience": true,
      "enable_balance_credits": true
    }
  },
  "features": {
    "allow_overdraft": true,
    "workflows": true,
    "broadcasts": true,
    "enable_japifon": true
  }
}
'
{
  "id": "<string>",
  "name": "<string>",
  "logo_url": "<string>",
  "plan": "free",
  "balance": 123,
  "promo_balance": 123,
  "billing": {
    "auto_recharge": {
      "enabled": true,
      "recharge_threshold": 252.5,
      "recharge_amount": 252.5
    },
    "use_parent_balance": true,
    "spending_cap": {
      "enabled": true,
      "amount": 50000,
      "reset_at": "2023-11-07T05:31:56Z"
    },
    "payment_method": {
      "type": "<string>",
      "payment_method_id": "<string>",
      "brand": "<string>",
      "last4": "<string>",
      "inactive": true,
      "failed_at": "2023-11-07T05:31:56Z",
      "failed_message": "<string>"
    },
    "last_low_balance_notification_at": "2023-11-07T05:31:56Z",
    "last_out_of_balance_notification_at": "2023-11-07T05:31:56Z",
    "last_spending_cap_notification_at": "2023-11-07T05:31:56Z"
  },
  "members": [
    {
      "id": "<string>",
      "name": "<string>",
      "email": "jsmith@example.com",
      "avatar": "<string>",
      "role": "ADMIN",
      "status": "ACTIVE",
      "org_id": "<string>",
      "user_id": "<string>",
      "preferences": {
        "notifications": {
          "assigned_to_me": {
            "enabled": true,
            "notified_at": "2023-11-07T05:31:56Z"
          }
        }
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "seen_at": "2023-11-07T05:31:56Z"
    }
  ],
  "spending_cap_used": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "features": {
    "enterprise": true,
    "allow_overdraft": true,
    "workflows": true,
    "broadcasts": true,
    "enable_japifon": true,
    "slack_access": true
  },
  "config": {
    "email": "jsmith@example.com",
    "address": "<string>",
    "terms_url": "<string>",
    "privacy_url": "<string>",
    "access": {
      "session_ttl_seconds": 0,
      "allow_google": true,
      "allow_email_code": true,
      "allow_invites": true
    },
    "modules": {
      "enable_inbox": true,
      "enable_analytics": true,
      "enable_boards": true,
      "enable_assistants": true,
      "enable_knowledge_base": true,
      "enable_broadcasts": true,
      "enable_workflows": true,
      "enable_audience": true,
      "enable_balance_credits": true
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

​
org_id
string
required

The ID of the parent organization

​
sub_org_id
string
required

The ID of the sub-organization

Body

Schema for updating a sub-organization from the parent. Accepts an optional name, a partial config (deep-merged on the server), an optional logo_id, and a deprecated features field that is ignored.

​
name
string
Required string length: 2 - 64
​
logo_id
string | null

Logo file id; pass null to clear

​
config
object

Organization configuration settings

​
features
object

[Deprecated] Legacy feature-delegation field. Ignored by the server; kept for backward compatibility. Feature flags are now managed exclusively by platform admins.

Response

200 - application/json

The updated sub-organization.

Summary information about a sub-organization

​
id
string
required

Unique identifier of the sub-organization

​
name
string
required

Name of the sub-organization

​
logo_url
string | null
required

URL of the sub-organization logo

​
plan
enum<string>
required

Type of subscription plan

Available options:
free,
business
​
balance
number
required

Current credit balance

​
promo_balance
number
required

Current promotional credit balance

​
billing
object
required

Schema for updating payment configuration

​
members
object[]
required

Members of the sub-organization

​
spending_cap_used
number
required

Amount spent in the current month

​
created_at
string<date-time> | null
required

Timestamp when the sub-organization was created

​
features
object

Org gate-keeping features configuration

​
config
object

Organization configuration settings