Create score CRM entry

POST 
/TransactionScoreCrm

Create score CRM entry

Request

application/json

Body

Trans Score Crm to create.

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.

Responses

201

trans score crm was created.

application/json

Schema

Schema

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

trans score crm is invalid.

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"
    }
  ]
}

406

Incorrect JSON format.

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"
    }
  ]
}

409

trans score crm already exists.

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