Send Docs Feedback

Create Company

Resource Summary


Content Type

application/json, text/xml





Create Company

Creates a company in an organization.

The company is always created with a status of active. To set the status explicitly, use Set the Status of a Company.

The attributes in the sample payload below apply to company configuration in monetization. For non-monetized companies, you need send only name and displayName.

To set the company's billing type (PREPAID to POSTPAID), make sure the organization profile is configured to support your setting (for example, set to accept BOTH). See Edit the organization profile.

CPS: With Core Persistence Services, the custom attribute limit is 18.


Resource URL /organizations/{org_name}/companies

Header Parameters

Name Values Description

Specify the Content-Type as application/json or text/xml.

Request Body

Name Description Default Required?
name Name of the company to be created. When defining the company name:
  • Use any of the following characters: [a-z][0-9]!#$&’*+/=?^_` {|}~-
  • Do not use comma or space characters.
  • The combined length of the company name and organization ID must not exceed 74 characters.
  • Use the Display Name (displayName) to provide a human-readable version of the company name, which can include upper-case, comma, and space characters.
N/A Yes
displayName Display name of the company to be created. N/A Yes
attributes Name/value formatted attributes used to extend the default company profile. N/A No

org_name Mention the organization name true

HTTP Basic

OAuth 2.0



Make a request and see the response.

Make a request and see the response.

Make a request and see the response.


Help or comments?