Create a new Organization

post

https://api.revenium.ai/profitstream/v2/api/organizations

Creates a new organization. tenantId is required in the request body to properly associate the organization with a tenant. parentId is optional: omit for top-level organizations; to create a nested organization, set parentId to an existing organization ID (retrieve with GET /v2/api/organizations?tenantId={tenantId}).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Organization configuration

name

string

required

The name of the organization

externalId

string

The organization's external id

logo

string

The organization's logo

address1

string

The organization's address 1

address2

string

The organization's address 2

city

string

The organization's city address

state

string

The organization's state address

country

string

The organization's country

postalCode

string

The organization's postal code

billingPhoneNumber

string

The organization's billing phone number

phoneNumber

string

The organization's phone number

emailAddress

string

The organization's contact email address

remittanceInstructions

string

The organization's remittance instructions

url

string

The organization's website URL

currency

string

The organization's currency

metadata

string

The organization's metadata (in key / value pairs)

domainAliases

array of strings

The organization's domain aliases

domainAliases

types

array of strings

enum

The organization type (array with single value). Use CONSUMER for organizations (end customers who consume APIs and accumulate usage costs). Note: MANAGING is used by team endpoints (see /v2/api/teams) and should not be used when creating organizations.

types

tenantId

string

required

The unique identifier of the tenant that owns this organization. Required to associate the organization with a tenant. Format: Revenium hashid (URL-safe encoded string).

parentId

string

Optional. Omit this field when creating a top-level organization. To create a nested organization, set parentId to an existing organization ID (retrieve IDs using GET /v2/api/organizations?tenantId={tenantId}). Format: Revenium hashid (URL-safe encoded string).

sourceAutoDiscoveryEnabled

boolean

Whether automatic discovery of API sources is enabled for this organization

elementDefinitionAutoDiscoveryEnabled

boolean

Whether automatic discovery of metering element definitions is enabled for this organization

billingEmail

string

The email address for billing-related communications

Responses

201Organization created successfully

400Invalid input data

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Referenced resource does not exist

409Conflict - Resource conflict

422Unprocessable entity - Validation failed