Create Company
An overview of the Create Company endpoint.
Endpoint Description
This endpoint allows you to create a new company (subscription). (Access to this endpoint must be requested, limited access is granted)
HTTP Method
POST /api/v2/companies
Request
Headers:
Content-Type:
application/json- Specifies that the request body format is JSON.Accept:
application/json- Indicates that the client expects a JSON response.Authorization:
Bearer {token}- A valid Bearer token must be provided to authenticate the request.
Body Parameters:
name (string, required): The name of the company. Example: Acme Corp
address1 (string, required): The primary address of the company. Example: 123 Main St
address2 (string, optional): The secondary address of the company. Example: Suite 456
city (string, required): The city of the company. Example: New York
state (string, required): The state of the company. Example: NY
zip (string, required): The zip code of the company. Example: 10001
country (string, required): The country code of the company. See List Countries global endpoint for country code list. Example: US
phone (string, optional): The primary phone number of the company. Example: 555-123-4567
email (string, required): The email of the company Super Admin. Example: [email protected]
status (string, required): The status of the company (published, expired). Example: published
total_licenses (integer, required): The total number of licenses. Example: 100
license_duration (string, required): The duration of the license (1-month, 1-year). Example: 1-year
Request Examples
Response
Data Dictionary:
id (Integer): The unique identifier for the company within the R1 Discover system.
name (string): The name of the company.
address1 (string): The address line of the company
address2 (string): The optional second address line for the company (Typically suite, unit, etc...)
city (string): The address city of the company
state (string): The address state of the company
zip (string): The address zip code of the company
status (string): The subscription status of the company (published, expired)
total_licenses (Integer): The total number of licenses available to the company
email1 (string): The email of the primary point of contact and super admin of the company
license_renewal_date (date): The subscription renewal date for the company licenses.
Response Examples
Postman Link
Notes
Authorization Required: Ensure the provided Bearer token is valid and has sufficient privileges to access the endpoint.
Last updated