Update an organization (internal)

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://docs.usehearsay.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "integrations MCP server": {
    "url": "https://docs.usehearsay.com/mcp"
  }
}

Close
PATCH /admin/organization/update-org/{orgId}

Updates the profile fields that are sent (name, email, logo, website, contact, address, description, phone, version); metadata is merged into the existing metadata instead of replacing it. Returns the updated organization, or 404 for an unknown one. Super admin only.

Path parameters

  • orgId string Required
application/json

Body Required

  • name string
  • website string
  • contact string
  • addressLine1 string
  • addressLine2 string
  • city string
  • state string
  • country string
  • zipCode string
  • email string
  • description string
  • phone array[string]

    Minimum value of each is 1, maximum value of each is 20.

  • metadata object
  • version string

    Values are v1, v2, eu, or ca.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • data object Required
      Hide data attributes Show data attributes object
      • createdAt string(date-time) Required
      • updatedAt string(date-time) Required
      • id string Required
      • name string Required
      • slug string Required
      • email string Required
      • contact string Required
      • city string Required
      • state string Required
      • country string Required
      • description string Required
      • phone array[string] Required
      • isActive boolean Required
      • isPriority boolean
      • activePlan object Required

        The full record on routes that load it; null (or an empty list) on routes that do not.

        Hide activePlan attributes Show activePlan attributes object
        • createdAt string(date-time) Required
        • updatedAt string(date-time) Required
        • id string Required
        • subscription object | null Required

          Not loaded on public routes, so always null there. Only the internal admin organization report loads it.

        • relatedSubscription array[object] | null Required

          Not loaded by any route, so always null or an empty list.

        • organization object | null Required

          Not loaded by any route, so always null.

        • seats number Required
        • seatsUsed number Required
        • devices number Required
        • deviceUsed number Required
        • storage number Required

          Storage in bytes

        • storageUsed number Required

          Storage used in bytes

        • payments array[object] | null Required

          Not loaded by any route, so always null or an empty list.

        • type string Required

          Values are admin, free, limited-access, trial, tier1, tier2, tier3, tier4, tier5, tier6, or tier7.

        • isActive boolean Required
        • isBetweenPlanChanges boolean Required
        • storageInKb number Required
        • storageUsedInKb number Required
        • storageInMb number Required
        • storageUsedInMb number Required
        • storageInGb number Required
        • storageUsedInGb number Required
        • storageInTb number Required
        • storageUsedInTb number Required
        • isFreePlan boolean Required
        • remainingSeats number Required
        • remainingDevices number Required
        • remainingStorage number Required

          Storage left in bytes (storage minus storageUsed).

      • metadata object Required
      • type string Required
      • version string Required

        Values are v1, v2, eu, or ca.

    • statusCode number Required
    • timestamp string(date-time) Required
PATCH /admin/organization/update-org/{orgId}
curl \
 --request PATCH 'http://api.example.com/admin/organization/update-org/{orgId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{
  "name": "string",
  "website": "string",
  "logo": "string",
  "contact": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "city": "string",
  "state": "string",
  "country": "string",
  "zipCode": "string",
  "email": "string",
  "description": "string",
  "phone": [
    "string"
  ],
  "metadata": {},
  "version": "v1"
}'
Request examples
{
  "name": "string",
  "website": "string",
  "logo": "string",
  "contact": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "city": "string",
  "state": "string",
  "country": "string",
  "zipCode": "string",
  "email": "string",
  "description": "string",
  "phone": [
    "string"
  ],
  "metadata": {},
  "version": "v1"
}
Response examples (200)
{
  "data": {
    "createdAt": "2026-01-15T14:30:00.000Z",
    "updatedAt": "2026-01-15T14:30:00.000Z",
    "id": "507f1f77bcf86cd799439011",
    "name": "Example Law LLP",
    "slug": "example-law-llp",
    "email": "office@example.com",
    "contact": "Jane Doe",
    "city": "New York",
    "state": "NY",
    "country": "US",
    "description": "Litigation practice",
    "phone": [
      "+15555550100"
    ],
    "logo": "https://files.example.com/logo.png",
    "isActive": true,
    "isPriority": false,
    "activePlan": {
      "createdAt": "2026-01-15T14:30:00.000Z",
      "updatedAt": "2026-01-15T14:30:00.000Z",
      "id": "507f1f77bcf86cd799439011",
      "subscription": {},
      "relatedSubscription": [
        {}
      ],
      "organization": {},
      "seats": 5,
      "seatsUsed": 3,
      "devices": 10,
      "deviceUsed": 4,
      "storage": 100000000000,
      "storageUsed": 12000000000,
      "payments": [
        {}
      ],
      "type": "admin",
      "isActive": true,
      "isBetweenPlanChanges": false,
      "storageInKb": 100000000,
      "storageUsedInKb": 12000000,
      "storageInMb": 100000,
      "storageUsedInMb": 12000,
      "storageInGb": 100,
      "storageUsedInGb": 12,
      "storageInTb": 0.1,
      "storageUsedInTb": 0.012,
      "isFreePlan": false,
      "remainingSeats": 2,
      "remainingDevices": 6,
      "remainingStorage": 88000000000
    },
    "metadata": {},
    "type": "law_firm",
    "version": "v1"
  },
  "statusCode": 200,
  "timestamp": "2026-01-15T10:15:00.000Z"
}