Create or Update an Organization

Group your users by company, team, or any organizational structure that makes sense for your business.

Provide an externalOrganizationId to identify the organization—your ID from your own system. Don’t worry about whether it already exists; we’ll create it if it’s new or update it if it already exists. This makes syncing organization data effortless.

Reference this organization when creating users (via /users) or logging messages (via /messages) using the same externalOrganizationId. Perfect for B2B products where you need to track which company each user belongs to.

POST /organizations

cURL

cURL

curl --request POST \
  --url https://www.greenflash.ai/api/v1/organizations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalOrganizationId": "org-456",
  "name": "Acme Corporation",
  "properties": {
    "industry": "technology",
    "size": "enterprise"
  }
}
'

200

{
  "success": true,
  "organization": {
    "id": "org-001",
    "externalId": "org-456",
    "name": "Acme Corporation",
    "properties": {
      "industry": "technology",
      "size": "enterprise"
    },
    "createdAt": "2025-07-01T12:00:00Z",
    "updatedAt": "2025-07-01T12:00:00Z"
  }
}

Authorizations

Authorization · string · header · required

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

Body

application/json

Request payload for creating a new organization.

externalOrganizationId · string · required

Your unique identifier for the organization. Use this same ID in other API calls to reference this organization.

name · string

The organization's name.

properties · object

Custom organization properties.

Show child attributes

Response

200

application/json

Organization created or updated successfully

Success response for organization creation.

success · boolean · required

Whether the API call was successful.

organization · object · required

The organization that was created or updated.

Show child attributes