Get one ProposedAction

GET

api

sys

proposedactions

{id}

Get one ProposedAction

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/proposedactions/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/proposedactions/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

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

{
  "BusinessId": 123,
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "CoworkerEmail": "<string>",
  "CoworkerCoworkerType": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerBillingName": "<string>",
  "AiChannelSessionId": 123,
  "CriteriaType": "<string>",
  "CriteriaPayload": "<string>",
  "ActionType": 123,
  "Channel": 123,
  "DraftSubject": "<string>",
  "DraftBody": "<string>",
  "Confidence": 123,
  "Priority": 123,
  "Status": 123,
  "ReviewedById": 123,
  "ReviewedByFullName": "<string>",
  "ReviewedByEmail": "<string>",
  "ReviewedOn": "<string>",
  "ReviewNotes": "<string>",
  "ExecutedOn": "<string>",
  "OutcomeSessionId": 123,
  "ExpiresOn": "<string>",
  "DeduplicationKey": "<string>",
  "ScheduledExecutionTime": "<string>",
  "DeferralReason": "<string>",
  "DeferralCount": 123,
  "EmailAccountId": 123,
  "EmailAccountDisplayName": "<string>",
  "EmailAccountEmailAddress": "<string>",
  "InternalNotes": "<string>",
  "HelpDeskDepartmentId": 123,
  "HelpDeskDepartmentName": "<string>",
  "HelpDeskPriority": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A ProposedAction is an AI-generated recommendation waiting in the operator AI Inbox, produced when one of the proactive agents spots an opportunity such as an overdue invoice, an expiring contract, a run of support tickets, a spike in one issue category or a gap in the FAQ. Each one carries a drafted message or an internal alert, a confidence score and a review deadline. Records are created by the proactive agents, never by hand, and cannot be deleted. Fields such as the drafted subject and body, the delivery channel and the review notes may be edited before the action goes out. Its lifecycle, however, is driven by the review operations: use the approve and reject commands (PROPOSEDACTION_APPROVE, PROPOSEDACTION_REJECT), which also deliver the message, rather than writing Status directly — setting Status by hand marks an action as handled without ever sending it. Which agents run and how they behave is configured through ProactiveActionConfig.

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 ProposedAction-Read role.

Path Parameters

integer

required

The Id of the ProposedAction record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/sys/proposedactions/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/proposedactions/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/proposedactions/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the location that owns this proposed action. Set from the location whose agents produced it..

integer

ID of the customer this action targets. Empty for internal alerts and for leads that have no customer record yet..

string

Display value for Coworker.FullName..

string

Display value for Coworker.Email..

string

Display value for Coworker.CoworkerType..

string

Display value for Coworker.CompanyName..

string

Display value for Coworker.BillingName..

integer

ID of the AI conversation that triggered this action. Only set for criteria that evaluate conversations, such as unanswered-question and dormant-lead detection..

string

Identifier of the agent that produced this action, matching a criteria evaluator name such as DueInvoiceCriteria, ContractExpiryCriteria, SupportPatternCriteria, SupportIssueCategoryCriteria or MissingFaqCriteria. Behaviour for each is configured through ProactiveActionConfig..

string

Read-only JSON snapshot of the evidence the criteria evaluator collected (for example invoice amounts and due dates, contract dates, support ticket summaries, or a drafted FAQ article). Shape varies per criteria type; returned by the detail operation only..

integer

What the action does once approved: DraftMessage sends a composed message to the customer, VoiceOutreach places an AI call, InternalNote raises an operator-only alert with no customer contact, TaskReminder records a follow-up. InternalNote actions have no customer target and no delivery channel.. See eProposedActionType enum values: 1 = DraftMessage, 2 = VoiceOutreach, 3 = InternalNote, 4 = TaskReminder.

integer

How an approved action reaches the customer: Email for an AI-tracked email conversation, Voice for an outbound AI call, CoworkerMessage for a message sent from a connected email account, HelpDesk to raise a ticket, or WhatsApp. Operators can change the channel at approval time. Ignored for InternalNote actions.. See eOutboundChannel enum values: 1 = Email, 2 = Voice, 3 = CoworkerMessage, 4 = HelpDesk, 5 = WhatsApp.

string

AI-composed subject line for the proposed message. Operators may edit it before approving; for internal alerts it doubles as the alert headline..

string

AI-composed message body, call script, or — for internal alerts — the alert text itself. Operators may edit it before approving..

number

AI confidence in this recommendation, on a 0.0–1.0 scale (not a percentage). When the matching ProactiveActionConfig enables auto-execution, an action at or above its AutoExecuteMinConfidence skips the review inbox..

integer

Urgency assigned by the agent that raised the action: Low, Medium, High or Critical. Drives inbox ordering and the urgency indicator; it does not change delivery behaviour.. See eProposedActionPriority enum values: 1 = Low, 2 = Medium, 3 = High, 4 = Critical.

integer

Where the action sits in its lifecycle: Pending awaits review; Snoozed is hidden until its wake time; Approved has been accepted for delivery; AutoExecuted was sent without review because confidence cleared the configured threshold; Deferred is approved but waiting for the recipient’s next calling window; AwaitingReply has sent a WhatsApp opt-in template and is waiting on the customer; Rejected was dismissed; Expired passed its review deadline unattended. Change it through the approve, reject and snooze operations rather than by writing this field.. See eProposedActionStatus enum values: 1 = Pending, 2 = Approved, 3 = Rejected, 4 = Expired, 5 = AutoExecuted, 6 = Snoozed, 7 = Deferred, 8 = AwaitingReply.

integer

ID of the operator who last reviewed this action. Empty while it is still awaiting review or when the system expired it unattended..

string

Display value for ReviewedBy.FullName..

string

Display value for ReviewedBy.Email..

string

UTC time an operator last approved, rejected or snoozed this action..

string

Notes recorded when an operator approves, rejects or snoozes the action. The system also appends here when it expires an action, for example because no calling window was available..

string

UTC time the approved action was actually delivered or the outbound call placed. Empty while the action is still queued or deferred..

integer

ID of the AI conversation created when this action was delivered. Use it to follow the reply thread, escalated tickets and messages that came out of the outreach..

string

UTC review deadline, defaulting to three days after the action is created. A Pending action past this point is moved to Expired; for a Snoozed action this instead holds the wake time set by the snooze duration..

string

Read-only key that prevents duplicate proposals for the same trigger, shaped as “criteria-type:{identifier}:{tier}” (for example “invoice:123:reminder:1”). A new proposal is suppressed while a non-expired action with the same key exists inside the criteria’s cooldown window..

string

UTC time a Deferred action becomes due, set automatically to the recipient’s next calling window when approval lands outside permitted outbound hours..

string

System-written explanation of why delivery was postponed, recorded when an approved action falls outside the recipient’s permitted calling hours..

integer

Number of times delivery has been postponed for calling hours. Counts up from zero and helps spot actions that keep missing their window..

integer

ID of the connected email account used as the sender when an approved action goes out over the CoworkerMessage channel. Empty means the location’s default outgoing mail settings are used and customer replies are not tracked back into the AI conversation..

string

Display value for EmailAccount.DisplayName..

string

Display value for EmailAccount.EmailAddress..

string

Internal context carried onto the help desk ticket created when a HelpDesk-channel action is approved. Visible to operators only, never to the customer..

integer

ID of the help desk department the ticket is filed under when a HelpDesk-channel action is approved. Empty leaves the ticket unassigned..

string

Display value for HelpDeskDepartment.Name..

integer

Priority applied to the help desk ticket created when a HelpDesk-channel action is approved (Low, Normal, High, Critical). Empty for actions on any other channel..

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "BusinessId": 0,
  "CoworkerId": null,
  "CoworkerFullName": null,
  "CoworkerEmail": null,
  "CoworkerCoworkerType": null,
  "CoworkerCompanyName": null,
  "CoworkerBillingName": null,
  "AiChannelSessionId": null,
  "CriteriaType": "",
  "CriteriaPayload": null,
  "ActionType": 0,
  "Channel": 0,
  "DraftSubject": null,
  "DraftBody": null,
  "Confidence": 0,
  "Priority": 0,
  "Status": 0,
  "ReviewedById": null,
  "ReviewedByFullName": null,
  "ReviewedByEmail": null,
  "ReviewedOn": null,
  "ReviewNotes": null,
  "ExecutedOn": null,
  "OutcomeSessionId": null,
  "ExpiresOn": null,
  "DeduplicationKey": null,
  "ScheduledExecutionTime": null,
  "DeferralReason": null,
  "DeferralCount": 0,
  "EmailAccountId": null,
  "EmailAccountDisplayName": null,
  "EmailAccountEmailAddress": null,
  "InternalNotes": null,
  "HelpDeskDepartmentId": null,
  "HelpDeskDepartmentName": null,
  "HelpDeskPriority": 0,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "ProposedAction Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one ProposedAction

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/proposedactions/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/proposedactions/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

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

{
  "BusinessId": 123,
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "CoworkerEmail": "<string>",
  "CoworkerCoworkerType": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerBillingName": "<string>",
  "AiChannelSessionId": 123,
  "CriteriaType": "<string>",
  "CriteriaPayload": "<string>",
  "ActionType": 123,
  "Channel": 123,
  "DraftSubject": "<string>",
  "DraftBody": "<string>",
  "Confidence": 123,
  "Priority": 123,
  "Status": 123,
  "ReviewedById": 123,
  "ReviewedByFullName": "<string>",
  "ReviewedByEmail": "<string>",
  "ReviewedOn": "<string>",
  "ReviewNotes": "<string>",
  "ExecutedOn": "<string>",
  "OutcomeSessionId": 123,
  "ExpiresOn": "<string>",
  "DeduplicationKey": "<string>",
  "ScheduledExecutionTime": "<string>",
  "DeferralReason": "<string>",
  "DeferralCount": 123,
  "EmailAccountId": 123,
  "EmailAccountDisplayName": "<string>",
  "EmailAccountEmailAddress": "<string>",
  "InternalNotes": "<string>",
  "HelpDeskDepartmentId": 123,
  "HelpDeskDepartmentName": "<string>",
  "HelpDeskPriority": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200