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

Bash

curl --request POST \
    "https://api.r1learning.com/api/v2/companies" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"name\": \"Acme Corp\",
    \"address1\": \"123 Main St\",
    \"address2\": \"Suite 456\",
    \"city\": \"New York\",
    \"state\": \"NY\",
    \"zip\": \"10001\",
    \"country\": \"US\",
    \"phone\": \"555-123-4567\",
    \"email\": \"[email protected]\",
    \"status\": \"published\",
    \"total_licenses\": 100,
    \"license_duration\": \"1-year\"
}"

JavaScript

const url = new URL(
    "https://api.r1learning.com/api/v2/companies"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "Bearer {token}",
};

let body = {
    "name": "Acme Corp",
    "address1": "123 Main St",
    "address2": "Suite 456",
    "city": "New York",
    "state": "NY",
    "zip": "10001",
    "country": "US",
    "phone": "555-123-4567",
    "email": "[email protected]",
    "status": "published",
    "total_licenses": 100,
    "license_duration": "1-year"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

C# - Http

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.r1learning.com/api/v2/companies");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer {token}");
var content = new StringContent("{\"name\":\"Acme Corp\",\"address1\":\"123 Main St\",\"address2\":\"Suite 456\",\"city\":\"New York\",\"state\":\"NY\",\"zip\":\"10001\",\"country\":\"US\",\"phone\":\"555-123-4567\",\"email\":\"[email protected]\",\"status\":\"published\",\"total_licenses\":100,\"license_duration\":\"1-year\"}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

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

200: OK

{
    "message": "Company created successfully",
    "data": {
        "id": 99,
        "name": "FB Test Comp 3",
        "address1": "15 North avenue",
        "address2": "Suite 100",
        "city": "Chicago",
        "state": "IL",
        "zip": "60610",
        "country": "US",
        "status": "published",
        "total_licenses": "10",
        "email1": "[email protected]",
        "license_renewal_date": "2025-10-01 00:41:10"
    }
}

401: Unauthorized

{
    "error": 1,
    "message": "Unauthenticated",
    "details": "Authentication is required to access this resource."
}

403: Unauthorized

{
    "error": 1,
    "message": "Unauthorized",
    "details": "You do not have the necessary permissions to perform this action."
}

Postman Link

https://www.postman.com/fbomher/r1-discover-api/request/8qub6up/create-companywww.postman.com

Link the endpoint in Postman

Notes

• Authorization Required: Ensure the provided Bearer token is valid and has sufficient privileges to access the endpoint.