Skip to main content
POST
/
public-api
/
end-companies
Create an end-company
curl --request POST \
  --url https://api.neoagent.io/public-api/end-companies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "psa_company_id": "<string>",
  "psa_company_name": "<string>",
  "auto_assign_exchange_admin": true,
  "custom_instructions": "<string>",
  "custom_instructions_for_user_facing_chat": "<string>",
  "employee_identity_provider": {
    "onprem_ad_adconnect_server_hostname": "<string>",
    "onprem_ad_runner_hostname": "<string>",
    "onprem_service_account_username": "<string>"
  },
  "mailbox_provider": {
    "onprem_exchange_runner_hostname": "<string>",
    "onprem_exchange_server_hostname": "<string>",
    "onprem_service_account_username": "<string>"
  },
  "marketplace_company_ids": [
    {
      "company_id": "<string>"
    }
  ],
  "tenant_id": "<string>"
}
'
import requests

url = "https://api.neoagent.io/public-api/end-companies"

payload = {
    "psa_company_id": "<string>",
    "psa_company_name": "<string>",
    "auto_assign_exchange_admin": True,
    "custom_instructions": "<string>",
    "custom_instructions_for_user_facing_chat": "<string>",
    "employee_identity_provider": {
        "onprem_ad_adconnect_server_hostname": "<string>",
        "onprem_ad_runner_hostname": "<string>",
        "onprem_service_account_username": "<string>"
    },
    "mailbox_provider": {
        "onprem_exchange_runner_hostname": "<string>",
        "onprem_exchange_server_hostname": "<string>",
        "onprem_service_account_username": "<string>"
    },
    "marketplace_company_ids": [{ "company_id": "<string>" }],
    "tenant_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    psa_company_id: '<string>',
    psa_company_name: '<string>',
    auto_assign_exchange_admin: true,
    custom_instructions: '<string>',
    custom_instructions_for_user_facing_chat: '<string>',
    employee_identity_provider: {
      onprem_ad_adconnect_server_hostname: '<string>',
      onprem_ad_runner_hostname: '<string>',
      onprem_service_account_username: '<string>'
    },
    mailbox_provider: {
      onprem_exchange_runner_hostname: '<string>',
      onprem_exchange_server_hostname: '<string>',
      onprem_service_account_username: '<string>'
    },
    marketplace_company_ids: [{company_id: '<string>'}],
    tenant_id: '<string>'
  })
};

fetch('https://api.neoagent.io/public-api/end-companies', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.neoagent.io/public-api/end-companies",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'psa_company_id' => '<string>',
    'psa_company_name' => '<string>',
    'auto_assign_exchange_admin' => true,
    'custom_instructions' => '<string>',
    'custom_instructions_for_user_facing_chat' => '<string>',
    'employee_identity_provider' => [
        'onprem_ad_adconnect_server_hostname' => '<string>',
        'onprem_ad_runner_hostname' => '<string>',
        'onprem_service_account_username' => '<string>'
    ],
    'mailbox_provider' => [
        'onprem_exchange_runner_hostname' => '<string>',
        'onprem_exchange_server_hostname' => '<string>',
        'onprem_service_account_username' => '<string>'
    ],
    'marketplace_company_ids' => [
        [
                'company_id' => '<string>'
        ]
    ],
    'tenant_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.neoagent.io/public-api/end-companies"

	payload := strings.NewReader("{\n  \"psa_company_id\": \"<string>\",\n  \"psa_company_name\": \"<string>\",\n  \"auto_assign_exchange_admin\": true,\n  \"custom_instructions\": \"<string>\",\n  \"custom_instructions_for_user_facing_chat\": \"<string>\",\n  \"employee_identity_provider\": {\n    \"onprem_ad_adconnect_server_hostname\": \"<string>\",\n    \"onprem_ad_runner_hostname\": \"<string>\",\n    \"onprem_service_account_username\": \"<string>\"\n  },\n  \"mailbox_provider\": {\n    \"onprem_exchange_runner_hostname\": \"<string>\",\n    \"onprem_exchange_server_hostname\": \"<string>\",\n    \"onprem_service_account_username\": \"<string>\"\n  },\n  \"marketplace_company_ids\": [\n    {\n      \"company_id\": \"<string>\"\n    }\n  ],\n  \"tenant_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.neoagent.io/public-api/end-companies")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"psa_company_id\": \"<string>\",\n  \"psa_company_name\": \"<string>\",\n  \"auto_assign_exchange_admin\": true,\n  \"custom_instructions\": \"<string>\",\n  \"custom_instructions_for_user_facing_chat\": \"<string>\",\n  \"employee_identity_provider\": {\n    \"onprem_ad_adconnect_server_hostname\": \"<string>\",\n    \"onprem_ad_runner_hostname\": \"<string>\",\n    \"onprem_service_account_username\": \"<string>\"\n  },\n  \"mailbox_provider\": {\n    \"onprem_exchange_runner_hostname\": \"<string>\",\n    \"onprem_exchange_server_hostname\": \"<string>\",\n    \"onprem_service_account_username\": \"<string>\"\n  },\n  \"marketplace_company_ids\": [\n    {\n      \"company_id\": \"<string>\"\n    }\n  ],\n  \"tenant_id\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.neoagent.io/public-api/end-companies")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"psa_company_id\": \"<string>\",\n  \"psa_company_name\": \"<string>\",\n  \"auto_assign_exchange_admin\": true,\n  \"custom_instructions\": \"<string>\",\n  \"custom_instructions_for_user_facing_chat\": \"<string>\",\n  \"employee_identity_provider\": {\n    \"onprem_ad_adconnect_server_hostname\": \"<string>\",\n    \"onprem_ad_runner_hostname\": \"<string>\",\n    \"onprem_service_account_username\": \"<string>\"\n  },\n  \"mailbox_provider\": {\n    \"onprem_exchange_runner_hostname\": \"<string>\",\n    \"onprem_exchange_server_hostname\": \"<string>\",\n    \"onprem_service_account_username\": \"<string>\"\n  },\n  \"marketplace_company_ids\": [\n    {\n      \"company_id\": \"<string>\"\n    }\n  ],\n  \"tenant_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "auto_assign_exchange_admin": true,
    "azure_application_access_granted": true,
    "azure_delegated_access_granted": true,
    "custom_instructions": "<string>",
    "custom_instructions_for_user_facing_chat": "<string>",
    "employee_identity_provider": {
      "onprem_ad_adconnect_server_hostname": "<string>",
      "onprem_ad_runner_hostname": "<string>",
      "onprem_service_account_username": "<string>"
    },
    "mailbox_provider": {
      "onprem_exchange_runner_hostname": "<string>",
      "onprem_exchange_server_hostname": "<string>",
      "onprem_service_account_username": "<string>"
    },
    "marketplace_company_ids": [
      {
        "company_id": "<string>"
      }
    ],
    "psa_company_id": "<string>",
    "psa_company_name": "<string>",
    "tenant_id": "<string>"
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timings_ms": {},
    "pagination": {
      "has_more": true,
      "next_cursor": "<string>"
    },
    "warnings": [
      "<string>"
    ]
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

​
Authorization
string
header
required

Authorization: Bearer <token> where <token> is either a neo_sk_<env>_<secret> API key (service account) or a Microsoft Entra ID access token (dashboard user).

Body

application/json
​
psa_company_id
string
required
​
psa_company_name
string
required
​
auto_assign_exchange_admin
boolean | null
​
custom_instructions
string | null
​
custom_instructions_for_user_facing_chat
string | null
​
employee_identity_provider
IdentityProvider · object | null
​
mailbox_provider
MailboxProvider · object | null
​
marketplace_company_ids
MarketplaceCompanyId · object[] | null
​
tenant_id
string | null

Response

Success.

​
data
PublicEndCompany · object
required
​
meta
object
required