Organization

Update organization

Updates core organization attributes (name, product, type, MFA) and syncs representatives, users, markets, and property-type access. Does NOT update contract, subscription, account limits, or surface-usage limits — use PUT /api/organization/{organizationId}/contract/update for those.

put/api/organization/{id}

Request

Path parameters

idinteger required

ID of the organization

Request body

namestring required
organization_type_idinteger required
product_idinteger required
mfa_enabledboolean
contract_status_idinteger
representative_idinteger required
representative_type'brand' | 'property' | 'agency' required
usersinteger[]
teamsinteger[]
agenciesinteger[]
companiesinteger[]
market_accessstring

Array or comma-separated list of market IDs

property_type_accessstring

Array or comma-separated list of property-type IDs

organization_limit_access_type_idinteger nullable

Access-limiting mode (FK to organization_limit_access_types). The 'none' row id or null both mean no restriction.

subcategory_accessstring

Array or comma-separated list of subcategory IDs

Example request

{
  "name": "Acme Sports",
  "organization_type_id": 1,
  "product_id": 1,
  "representative_id": 12362,
  "representative_type": "property",
  "representatives": [
    {
      "representative_id": 12362,
      "representative_type": "property",
      "is_main": 1
    }
  ],
  "market_access": "336,420,337",
  "property_type_access": "1,5,833",
  "organization_limit_access_type_id": 2,
  "subcategory_access": "14,27"
}

Response

Organization updated

Changes

No recorded changes to this operation across all 2 revisions of this API.