Skip to main content
PUT
/
app
/
v1
/
organizations
/
{organizationId}
Update Organization
curl --request PUT \
  --url https://api.example.com/app/v1/organizations/{organizationId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
Updates an organization’s name or description. The authenticated user must be an organization admin.

Path Parameters

organizationId
string
required
Organization ID

Request Body

name
string
Organization name (1-255 characters)
description
string
Organization description (max 1000 characters, can be null to clear)

Example Request

{
  "name": "Acme Corporation",
  "description": "Updated organization description"
}

Response

Returns the updated Organization object.
{
  "id": "org123",
  "name": "Acme Corporation",
  "slug": "acme-corp",
  "description": "Updated organization description",
  "status": "active",
  "settings": {
    "timezone": "America/Los_Angeles",
    "locales": ["en-US", "es-ES", "fr-FR"],
    "features": {
      "assetOptimization": true,
      "advancedPermissions": true
    }
  },
  "roles": {
    "role123": "Editor",
    "role456": "Viewer"
  },
  "metadata": {
    "createdBy": "user123",
    "maxProjects": 10
  },
  "subscription": {
    "tierId": "tier_pro",
    "status": "active",
    "currentPeriodStart": "2024-03-01T00:00:00Z",
    "currentPeriodEnd": "2024-04-01T00:00:00Z"
  },
  "createdAt": "2024-01-15T10:00:00Z",
  "updatedAt": "2024-03-21T10:00:00Z"
}

Error Responses

Organization Not Found

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Organization org123 was not found"
  }
}

Forbidden

{
  "error": {
    "code": "FORBIDDEN",
    "message": "This request is forbidden for your roles"
  }
}

Code Examples

curl -X PUT "https://api.metabind.ai/app/v1/organizations/org123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Corporation",
    "description": "Updated organization description"
  }'