How an edited, unsaved set-up would move contacts between bands (nothing is saved)

POST

/api/v1/workspaces/{workspace}/scoring/preview

curl --request POST \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/scoring/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "config": { "bands": { "hotFrom": 1, "warmFrom": 1 }, "decay": { "afterWeeks": 1, "enabled": true, "percent": 1 }, "rules": [ { "cap": { "kind": "none", "points": 1 }, "contains": "example", "enabled": true, "event": "example", "field": "example", "formId": "example", "id": "example", "kind": "open", "listId": "example", "op": "is_one_of", "points": 1, "values": [ "example" ] } ] } }'

• Your ReputeCast public URL

Permission: scoring:edit

Authorizations

• bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

Request Body^required

Media typeapplication/json

object

config

required

object

bands

required

object

hotFrom

required

integer format: int64

>= 2 <= 100

warmFrom

required

integer format: int64

>= 1 <= 99

decay

required

object

afterWeeks

required

integer format: int64

>= 1 <= 52

enabled

required

boolean

percent

required

integer format: int64

>= 1 <= 100

rules

required

Array<object>

<= 50 items

object

cap

required

object

kind

required

string

Allowed values: none once once_day once_week once_month points_day points_week points_month while_true

points

integer format: int64

<= 1000

contains

string

<= 200 characters

enabled

required

boolean

event

string

<= 100 characters

field

string

<= 64 characters

formId

string

<= 40 characters

id

required

Kept across versions; new rules get one when saved

string

<= 40 characters

kind

required

string

Allowed values: open click form api_event soft_bounce unsubscribe field

listId

string

<= 40 characters

op

string

Allowed values: is_one_of is_not is_set

points

required

integer format: int64

>= -50 <= 50

values

Array<string>

<= 20 items

Responses

200

OK

Media typeapplication/json

object

automations

required

Array<object>

object

crossed

required

integer format: int64

direction

required

string

Allowed values: rises falls

id

required

string

name

required

string

started

required

integer format: int64

threshold

required

integer format: int64

bandsAfter

required

object

cold

required

integer format: int64

hot

required

integer format: int64

warm

required

integer format: int64

bandsBefore

required

object

cold

required

integer format: int64

hot

required

integer format: int64

warm

required

integer format: int64

changed

required

integer format: int64

contacts

required

integer format: int64

current

required

Array<object>

object

contacts

required

integer format: int64

from

required

integer format: int64

to

required

integer format: int64

durationMs

required

integer format: int64

estimated

required

boolean

fieldMatches

required

object

key

additional properties

integer format: int64

moves

required

Array<object>

object

count

required

integer format: int64

from

required

string

Allowed values: cold warm hot

to

required

string

Allowed values: cold warm hot

rescored

required

integer format: int64

spread

required

Array<object>

object

contacts

required

integer format: int64

from

required

integer format: int64

to

required

integer format: int64

Example

{
  "automations": [
    {
      "direction": "rises"
    }
  ],
  "moves": [
    {
      "from": "cold",
      "to": "cold"
    }
  ]
}

default

Error

Media typeapplication/problem+json

object

code

Stable error code, e.g. permission_denied

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object>

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

helpers

Members who hold the missing permission

Array<string>

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

meta

object

key

additional properties

permission

The missing permission key

string

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}