Update Businesses Enrollments

curl --request PATCH \
  --url https://api.explorium.ai/v1/businesses/events/enrollments \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "enrollment_key": "<string>",
  "event_types": [],
  "enrollment_id": "<string>",
  "business_ids": [
    "<string>"
  ],
  "request_context": null
}
'

import requests

url = "https://api.explorium.ai/v1/businesses/events/enrollments"

payload = {
    "enrollment_key": "<string>",
    "event_types": [],
    "enrollment_id": "<string>",
    "business_ids": ["<string>"],
    "request_context": None
}
headers = {
    "api_key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    enrollment_key: '<string>',
    event_types: [],
    enrollment_id: '<string>',
    business_ids: ['<string>'],
    request_context: null
  })
};

fetch('https://api.explorium.ai/v1/businesses/events/enrollments', 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.explorium.ai/v1/businesses/events/enrollments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'enrollment_key' => '<string>',
    'event_types' => [
        
    ],
    'enrollment_id' => '<string>',
    'business_ids' => [
        '<string>'
    ],
    'request_context' => null
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "api_key: <api-key>"
  ],
]);

$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.explorium.ai/v1/businesses/events/enrollments"

	payload := strings.NewReader("{\n  \"enrollment_key\": \"<string>\",\n  \"event_types\": [],\n  \"enrollment_id\": \"<string>\",\n  \"business_ids\": [\n    \"<string>\"\n  ],\n  \"request_context\": null\n}")

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

	req.Header.Add("api_key", "<api-key>")
	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.patch("https://api.explorium.ai/v1/businesses/events/enrollments")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"enrollment_key\": \"<string>\",\n  \"event_types\": [],\n  \"enrollment_id\": \"<string>\",\n  \"business_ids\": [\n    \"<string>\"\n  ],\n  \"request_context\": null\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.explorium.ai/v1/businesses/events/enrollments")

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

request = Net::HTTP::Patch.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"enrollment_key\": \"<string>\",\n  \"event_types\": [],\n  \"enrollment_id\": \"<string>\",\n  \"business_ids\": [\n    \"<string>\"\n  ],\n  \"request_context\": null\n}"

response = http.request(request)
puts response.read_body

{
  "response_context": {
    "correlation_id": "<string>",
    "time_took_in_seconds": 123
  },
  "enrollment_key": "<string>",
  "enrollment_id": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

PATCH

businesses

events

enrollments

Update Businesses Enrollments

curl --request PATCH \
  --url https://api.explorium.ai/v1/businesses/events/enrollments \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "enrollment_key": "<string>",
  "event_types": [],
  "enrollment_id": "<string>",
  "business_ids": [
    "<string>"
  ],
  "request_context": null
}
'

import requests

url = "https://api.explorium.ai/v1/businesses/events/enrollments"

payload = {
    "enrollment_key": "<string>",
    "event_types": [],
    "enrollment_id": "<string>",
    "business_ids": ["<string>"],
    "request_context": None
}
headers = {
    "api_key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    enrollment_key: '<string>',
    event_types: [],
    enrollment_id: '<string>',
    business_ids: ['<string>'],
    request_context: null
  })
};

fetch('https://api.explorium.ai/v1/businesses/events/enrollments', 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.explorium.ai/v1/businesses/events/enrollments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'enrollment_key' => '<string>',
    'event_types' => [
        
    ],
    'enrollment_id' => '<string>',
    'business_ids' => [
        '<string>'
    ],
    'request_context' => null
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "api_key: <api-key>"
  ],
]);

$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.explorium.ai/v1/businesses/events/enrollments"

	payload := strings.NewReader("{\n  \"enrollment_key\": \"<string>\",\n  \"event_types\": [],\n  \"enrollment_id\": \"<string>\",\n  \"business_ids\": [\n    \"<string>\"\n  ],\n  \"request_context\": null\n}")

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

	req.Header.Add("api_key", "<api-key>")
	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.patch("https://api.explorium.ai/v1/businesses/events/enrollments")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"enrollment_key\": \"<string>\",\n  \"event_types\": [],\n  \"enrollment_id\": \"<string>\",\n  \"business_ids\": [\n    \"<string>\"\n  ],\n  \"request_context\": null\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.explorium.ai/v1/businesses/events/enrollments")

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

request = Net::HTTP::Patch.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"enrollment_key\": \"<string>\",\n  \"event_types\": [],\n  \"enrollment_id\": \"<string>\",\n  \"business_ids\": [\n    \"<string>\"\n  ],\n  \"request_context\": null\n}"

response = http.request(request)
puts response.read_body

{
  "response_context": {
    "correlation_id": "<string>",
    "time_took_in_seconds": 123
  },
  "enrollment_key": "<string>",
  "enrollment_id": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Description

Update an existing enrollment.

How It Works

Input: Define parameters including enrollment_key and enrollment_id to update, and updated business_ids, and event_types.
Processing: The system will update your your enrollment and update the monitoring for events.
Output: A confirmation response containing your enrollment_key and enrollment_id for future reference.

Query Parameters

Field	Type	Description
enrollment_key	String	A unique identifier for this enrollment
enrollment_id	String	A unique identifier for this enrollment
business_ids	Array	List of Business IDs to monitor for events
event_types	Array	Types of events to monitor (e.g., ipo_announcement, new_funding_round)

Example Request (cURL)

Bash

curl -X PATCH \
  "https://api.explorium.ai/v1/businesses/events/enrollments" \
  -H "API_KEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "enrollment_key": "my_b2b_saas_monitor",
  "enrollment_id": "en_7b429a01",
  "business_ids": [
    "8adce3ca1cef0c986b22310e369a0793",
    "665595bbb4e724de6f8bc705a5b84753"
  ],
  "event_types": [
    "ipo_announcement",
    "new_funding_round",
    "new_product"
  ]
}'

Example Response

JSON

{
  "request_context": {
    "correlation_id": "1234",
    "request_status": "success",
    "time_took_in_seconds": 0.515
  },
  "enrollment_key": "my_b2b_saas_monitor",
  "enrollment_id": "en_7b429a01"
}

Authorizations

api_key

string

header

required

Body

application/json

enrollment_key

string

required

Minimum string length: 4

event_types

enum<string>[]

required

Minimum array length: 1

Enumeration of business-related event identifiers.

This enum defines various types of events associated with businesses, such as:

Financial activities (e.g., IPO announcements, new funding rounds, new investments)
Organizational changes (e.g., new offices, closing offices, mergers and acquisitions)
Workforce trends (e.g., hiring in specific departments, increases or decreases in department sizes)
Product and partnership updates (e.g., new products, new partnerships)
Other significant events (e.g., company awards, outages, cost-cutting measures, legal issues)

These identifiers are used to categorize and track business events within the application.

Available options:

ipo_announcement,

new_funding_round,

new_investment,

new_product,

new_office,

closing_office,

new_partnership,

increase_in_engineering_department,

increase_in_sales_department,

increase_in_marketing_department,

increase_in_operations_department,

increase_in_customer_service_department,

increase_in_all_departments,

decrease_in_engineering_department,

decrease_in_sales_department,

decrease_in_marketing_department,

decrease_in_operations_department,

decrease_in_customer_service_department,

decrease_in_all_departments,

employee_joined_company,

hiring_in_creative_department,

hiring_in_education_department,

hiring_in_engineering_department,

hiring_in_finance_department,

hiring_in_health_department,

hiring_in_human_resources_department,

hiring_in_legal_department,

hiring_in_marketing_department,

hiring_in_operations_department,

hiring_in_professional_service_department,

hiring_in_sales_department,

hiring_in_support_department,

hiring_in_trade_department,

hiring_in_unknown_department,

company_award,

outages_and_security_breaches,

cost_cutting,

merger_and_acquisitions,

lawsuits_and_legal_issues

enrollment_id

string

required

business_ids

string[]

required

Required array length: 1 - 20 elements

Pattern: ^[a-f0-9]{32}$

request_context

Request Context · object | null

Example:

null

Response

Successful Response

This is base response model for all responses in partner service.

response_context

ResponseContext · object

required

Show child attributes

enrollment_key

string

required

Minimum string length: 4

enrollment_id

string

required

Add Businesses Enrollments Delete Businesses Enrollments

⌘I

Explorium AgentSource

Partners

Update Businesses Enrollments

Description

Authorizations

Body

Response

​Description

Authorizations

Body

Response

Description