Create ProactiveActionConfig

POST

api

sys

proactiveactionconfigs

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/proactiveactionconfigs \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "CriteriaType": "<string>",
  "AutoExecuteMinConfidence": 123,
  "CooldownHours": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/sys/proactiveactionconfigs"

payload = {
    "BusinessId": 123,
    "CriteriaType": "<string>",
    "AutoExecuteMinConfidence": 123,
    "CooldownHours": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    BusinessId: 123,
    CriteriaType: '<string>',
    AutoExecuteMinConfidence: 123,
    CooldownHours: 123
  })
};

fetch('https://spaces.nexudus.com/api/sys/proactiveactionconfigs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

A ProactiveActionConfig is the settings row for one proactive AI agent at one location: whether it runs at all, whether it may act without human review and above what confidence, how many actions it may raise per day, how long it waits before repeating itself, which delivery channel it prefers, and any custom drafting or voice prompts. There is at most one row per location and CriteriaType, and an agent with no row is off. The default posture is human-in-the-loop: the agent raises ProposedAction records into the operator AI Inbox for review, and only turning on AutoExecute lets sufficiently confident actions go out unattended.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the ProactiveActionConfig-Create role.

Enums

eOutboundChannel

Value	Name
1	Email
2	Voice
3	CoworkerMessage
4	HelpDesk
5	WhatsApp

Request Body

Required Fields

integer

required

ID of the location this agent configuration applies to. Each location holds at most one configuration per CriteriaType, and an agent with no configuration row is treated as off..

string

required

Name of the proactive agent this configuration governs, matching a criteria evaluator: DueInvoiceCriteria, ContractExpiryCriteria, SupportPatternCriteria, SupportIssueCategoryCriteria or MissingFaqCriteria. Unique per location; the actions it produces carry the same value in ProposedAction.CriteriaType..

number

required

Confidence an action must reach before AutoExecute will send it without review, on a 0.0–1.0 scale (not a percentage). Defaults to 0.85. Has no effect while AutoExecute is false..

integer

required

How long the agent waits before raising the same trigger again, in hours; defaults to 24. A candidate is skipped when a non-expired action with the same deduplication key was created inside this window, so in practice it throttles repeat outreach about the same invoice, contract or customer..

Optional Fields

boolean

Whether this agent runs for the location. When false, or when no configuration row exists at all, the agent is skipped entirely and proposes nothing..

boolean

Whether this agent may act without human review. When true, an action whose confidence reaches AutoExecuteMinConfidence is delivered straight away and recorded as AutoExecuted; anything below it still lands in the inbox. Internal-alert agents ignore this..

integer

Cap on how many actions this agent may raise for the location in a single day; it also caps how many candidates one evaluation run will consider. Empty means uncapped, in which case a run still considers at most 20 candidates..

integer

Overrides the delivery channel this agent proposes: Email, Voice, CoworkerMessage, HelpDesk or WhatsApp. Empty leaves the choice to the agent’s own default. Voice requires the location’s AI voice channel to be enabled, and WhatsApp requires a configured WhatsApp number.. See eOutboundChannel? enum above.

string

Extra drafting instructions for this agent, up to 2000 characters, appended to its built-in prompt — for example a tone or signature convention. Starting the text with “OVERRIDE:” (case-insensitive) replaces the agent’s whole prompt template instead of adding to it..

string

Opening line spoken or sent when this agent starts an outbound conversation, up to 500 characters. Supports {{variable}} placeholders such as {{company_name}} plus the agent-specific variables listed by the criteria-variables endpoint. Empty uses the built-in opening..

string

Voice-agent system prompt for outbound conversations this agent starts, up to 2000 characters. By default the text is added to the standard prompt; starting it with “OVERRIDE:” (case-insensitive) replaces the standard prompt entirely, and the server then rejects the save unless the text also contains the {{voice_message}} placeholder..

string

Agent-specific thresholds as a flat JSON object of string values, keyed by the parameter keys the criteria-parameters endpoint publishes for this CriteriaType — for example reminder day counts, minimum invoice amounts or ticket thresholds. Empty means every parameter falls back to its published default..

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/sys/proactiveactionconfigs" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "CriteriaType": "",
    "AutoExecuteMinConfidence": 0,
    "CooldownHours": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/proactiveactionconfigs',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      CriteriaType: '',
      AutoExecuteMinConfidence: 0,
      CooldownHours: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/sys/proactiveactionconfigs',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'CriteriaType': '',
        'AutoExecuteMinConfidence': 0,
        'CooldownHours': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the proactiveactionconfig was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "ProactiveActionConfig was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "CriteriaType: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "CriteriaType"
    }
  ],
  "WasSuccessful": false
}

Create ProactiveActionConfig

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/proactiveactionconfigs \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "CriteriaType": "<string>",
  "AutoExecuteMinConfidence": 123,
  "CooldownHours": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/sys/proactiveactionconfigs"

payload = {
    "BusinessId": 123,
    "CriteriaType": "<string>",
    "AutoExecuteMinConfidence": 123,
    "CooldownHours": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    BusinessId: 123,
    CriteriaType: '<string>',
    AutoExecuteMinConfidence: 123,
    CooldownHours: 123
  })
};

fetch('https://spaces.nexudus.com/api/sys/proactiveactionconfigs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400