Batch update score CRM entries

POST 
/TransactionScoreCrm/BatchActions

Batch update score CRM entries

Request

application/json

Body

The batch actions request containing details of the actions to be performed.

transactionScoreCrmList object[]nullable
The list of transaction score CRM records to create.
Array [
id int32required
The unique identifier of this record.
scoreFrom int32required
The lower bound of the score range for this CRM action.
scoreTo int32required
The upper bound of the score range for this CRM action.
workFlowTemplateCode stringnullablerequired
The code of the workflow template to trigger for this score range.
priority int32required
Possible values: [0, 1, 2, 3]
The priority level assigned to the alert or action.
createAlert booleanrequired
Indicates whether an alert should be created for this score range.
groupCode stringnullablerequired
The unique code identifying the customer group.
createdBy stringnullablerequired
The username or identifier of the user who created this record.
]
transactionScoreCrmUpdateRequestList object[]nullable
The list of transaction score CRM records to update.
Array [
id int32required
The unique identifier of this record.
scoreFrom int32required
The lower bound of the score range for this CRM action.
scoreTo int32required
The upper bound of the score range for this CRM action.
workFlowTemplateCode stringnullablerequired
The code of the workflow template to trigger for this score range.
priority int32required
Possible values: [0, 1, 2, 3]
The priority level assigned to the alert or action.
createAlert booleanrequired
Indicates whether an alert should be created for this score range.
groupCode stringnullablerequired
The unique code identifying the customer group.
updatedBy stringnullablerequired
The username or identifier of the user who last updated this record.
]
transactionScoreCrmDeleteList int32[]nullablerequired

The list of transaction score CRM record IDs to delete.

Responses

200

The updated collection of transaction scores after batch actions are applied.

application/json

Schema

Schema

• Array [
id int32required

The unique identifier of this record.

scoreFrom int32required

The lower bound of the score range for this CRM action.

scoreTo int32required

The upper bound of the score range for this CRM action.

workFlowTemplateCode stringnullablerequired

The code of the workflow template to trigger for this score range.

priority int32required

Possible values: [0, 1, 2, 3]

The priority level assigned to the alert or action.

createAlert booleanrequired

Indicates whether an alert should be created for this score range.

groupCode stringnullablerequired

The unique code identifying the customer group.

createdBy stringnullablerequired

The username or identifier of the user who created this record.

updatedBy stringnullablerequired

The username or identifier of the user who last updated this record.

• ]

Example (from schema)

[
  {
    "id": 0,
    "scoreFrom": 0,
    "scoreTo": 0,
    "workFlowTemplateCode": "string",
    "priority": 0,
    "createAlert": true,
    "groupCode": "string",
    "createdBy": "string",
    "updatedBy": "string"
  }
]

400

Bad Request if the batch actions request contains invalid data.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Loading...