Update ProposedAction

PUT

api

sys

proposedactions

curl --request PUT \
  --url https://spaces.nexudus.com/api/sys/proposedactions \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "CriteriaType": "<string>",
  "ActionType": 123,
  "Channel": 123,
  "Confidence": 123,
  "Priority": 123,
  "Status": 123,
  "DeferralCount": 123
}
'

import requests

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

payload = {
    "Id": 123,
    "BusinessId": 123,
    "CriteriaType": "<string>",
    "ActionType": 123,
    "Channel": 123,
    "Confidence": 123,
    "Priority": 123,
    "Status": 123,
    "DeferralCount": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    BusinessId: 123,
    CriteriaType: '<string>',
    ActionType: 123,
    Channel: 123,
    Confidence: 123,
    Priority: 123,
    Status: 123,
    DeferralCount: 123
  })
};

fetch('https://spaces.nexudus.com/api/sys/proposedactions', 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>"
    }
  ]
}

Updates an existing ProposedAction record. You must include the Id of the record to update along with all required fields.

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-Edit role.

Enums

eProposedActionType — ActionType values

Value	Name
1	DraftMessage
2	VoiceOutreach
3	InternalNote
4	TaskReminder

eOutboundChannel — Channel values

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

eProposedActionPriority — Priority values

Value	Name
1	Low
2	Medium
3	High
4	Critical

eProposedActionStatus — Status values

Value	Name
1	Pending
2	Approved
3	Rejected
4	Expired
5	AutoExecuted
6	Snoozed
7	Deferred
8	AwaitingReply

eHelpDeskMessagePriority

Value	Name
1	Low
2	Normal
3	High
4	Critical

Request Body

Required Fields

integer

required

The Id of the ProposedAction record to update.

integer

required

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

string

required

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..

integer

required

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..

integer

required

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..

number

required

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

required

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..

integer

required

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..

integer

required

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

Optional Fields

integer

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

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

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..

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

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

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

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..

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.. See eHelpDeskMessagePriority? enum above.

Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/sys/proposedactions" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "CriteriaType": "",
    "ActionType": 0,
    "Channel": 0,
    "Confidence": 0,
    "Priority": 0,
    "Status": 0,
    "DeferralCount": 0,
    "Id": 87654321
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/proposedactions',
  {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      CriteriaType: '',
      ActionType: 0,
      Channel: 0,
      Confidence: 0,
      Priority: 0,
      Status: 0,
      DeferralCount: 0,
      Id: 87654321
    })
  }
);

const data = await response.json();

import requests

response = requests.put(
    'https://spaces.nexudus.com/api/sys/proposedactions',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'CriteriaType': '',
        'ActionType': 0,
        'Channel': 0,
        'Confidence': 0,
        'Priority': 0,
        'Status': 0,
        'DeferralCount': 0,
        'Id': 87654321
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the update.

object

Contains the Id of the updated record.

boolean

true if the proposedaction was updated successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "ProposedAction was successfully updated.",
  "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
}

Update ProposedAction

curl --request PUT \
  --url https://spaces.nexudus.com/api/sys/proposedactions \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "CriteriaType": "<string>",
  "ActionType": 123,
  "Channel": 123,
  "Confidence": 123,
  "Priority": 123,
  "Status": 123,
  "DeferralCount": 123
}
'

import requests

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

payload = {
    "Id": 123,
    "BusinessId": 123,
    "CriteriaType": "<string>",
    "ActionType": 123,
    "Channel": 123,
    "Confidence": 123,
    "Priority": 123,
    "Status": 123,
    "DeferralCount": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    BusinessId: 123,
    CriteriaType: '<string>',
    ActionType: 123,
    Channel: 123,
    Confidence: 123,
    Priority: 123,
    Status: 123,
    DeferralCount: 123
  })
};

fetch('https://spaces.nexudus.com/api/sys/proposedactions', 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