Skip to content
ReputeCastReputeCast Docs

Save the rules, decay and bands (recalculates every contact in the background when the rules change)

PUT
/api/v1/workspaces/{workspace}/scoring
curl --request PUT \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/scoring \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "baseVersion": 1, "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" ] } ] }, "startAutomations": true }'

Permission: scoring:edit

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace
required

Workspace slug

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

Workspace slug

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
baseVersion
required
integer format: int64
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
startAutomations
boolean

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
appliedVersion
required
integer format: int64
bands
required
object
cold
required
integer format: int64
hot
required
integer format: int64
warm
required
integer format: int64
byTier
required
Array<object>
object
cold
required
integer format: int64
contacts
required
integer format: int64
hot
required
integer format: int64
tier
required
string
Allowed values: active cooling at_risk sunset
warm
required
integer format: int64
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
configured
required
boolean
contacts
required
integer format: int64
helpers
required
Array<string>
options
required
object
apiEvents
required
Array<object>
object
count
required
integer format: int64
name
required
string
fields
required
Array<object>
object
key
required
string
label
required
string
options
required
Array<string>
type
required
string
forms
required
Array<object>
object
id
required
string
kind
required
string
Allowed values: embedded popup hosted
name
required
string
lists
required
Array<object>
object
id
required
string
name
required
string
recalculation
object
changes
required
object
bands
required
boolean
decay
required
boolean
rules
required
Array<integer>
setup
required
boolean
done
required
integer format: int64
failedAt
string format: date-time
finishedAt
string format: date-time
id
required
string
label
required
string
reason
required
string
Allowed values: setup rules retry
remainingSeconds
integer format: int64
startAutomations
required
boolean
startedAt
required
string format: date-time
startedBy
required
string
status
required
string
Allowed values: running finished failed superseded
summary
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
bands
required
object
cold
required
integer format: int64
hot
required
integer format: int64
warm
required
integer format: int64
changed
required
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
total
required
integer format: int64
setUpAt
string format: date-time
setUpBy
required
string
spread
required
Array<object>
object
contacts
required
integer format: int64
from
required
integer format: int64
to
required
integer format: int64
suggested
required
Array<object>
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
tierExample
object
id
required
string
name
required
string
score
required
integer format: int64
usedBy
required
Array<object>
object
by
string
conditions
contacts
integer format: int64
direction
string
entered
required
integer format: int64
href
string
id
required
string
kind
required
string
Allowed values: automation segment block
name
required
string
of
integer format: int64
onceInDays
integer format: int64
show
string
Allowed values: only except
since
string format: date-time
status
string
threshold
integer format: int64
where
string
version
required
integer format: int64

Example 

{
  "byTier": [
    {
      "tier": "active"
    }
  ],
  "config": {
    "rules": [
      {
        "cap": {
          "kind": "none"
        },
        "kind": "open",
        "op": "is_one_of"
      }
    ]
  },
  "options": {
    "forms": [
      {
        "kind": "embedded"
      }
    ]
  },
  "recalculation": {
    "reason": "setup",
    "status": "running",
    "summary": {
      "automations": [
        {
          "direction": "rises"
        }
      ],
      "moves": [
        {
          "from": "cold",
          "to": "cold"
        }
      ]
    }
  },
  "suggested": [
    {
      "cap": {
        "kind": "none"
      },
      "kind": "open",
      "op": "is_one_of"
    }
  ],
  "usedBy": [
    {
      "kind": "automation",
      "show": "only"
    }
  ]
}

default

Section titled “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"
}
Report a problem with this pageReputeCast websiteHostReputeContent licensed under CC BY 4.0