Update Organization

Update specific fields of an existing organization without changing everything.

The organizationId in the URL path should be your externalOrganizationId. Only the fields you include in your request will be updated—everything else stays the same. Perfect for targeted updates like renaming a company or updating properties.

Prefer a simpler approach? Use POST /organizations instead—it automatically creates or updates the organization, so you don’t need to know if it exists yet.

PUT /organizations/{organizationId}

cURL

cURL

curl --request PUT \
  --url https://www.greenflash.ai/api/v1/organizations/{organizationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Organization Name",
  "properties": {
    "industry": "fintech",
    "size": "enterprise"
  }
}
'

200

{
  "success": true,
  "organization": {
    "id": "org-001",
    "externalId": "org-456",
    "name": "Updated Organization Name",
    "properties": {
      "industry": "fintech",
      "size": "enterprise"
    },
    "createdAt": "2025-07-01T12:00:00Z",
    "updatedAt": "2025-09-27T14:30:00Z"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationId · string · required

Your external organization ID (the externalOrganizationId used when creating the organization)

Body

application/json

Request payload for updating an organization.

name · string

The organization's name.

properties · object

Custom organization properties.

Show child attributes

Response

200

application/json

Organization updated successfully

Success response for organization update.

success · boolean · required

Whether the API call was successful.

organization · object · required

The organization that was created or updated.

Show child attributes