Skip to content

What a change of the counting rules does to referrals not decided yet

POST
/api/v1/workspaces/{workspace}/grow/referrals/{program}/settings/impact
curl --request POST \
--url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/grow/referrals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/settings/impact \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "burst": { "on": true, "threshold": 1 }, "disposable": true, "holdDays": 0, "left": true, "numbered": true, "sameIp": true, "sharedIp": { "on": true, "threshold": 1 } }'

Permission: grow:view

workspace
required

Workspace slug

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

Workspace slug

program
required
string format: uuid
Media typeapplication/json
object
burst
required
object
on
required
boolean
threshold
required
integer format: int64
>= 1 <= 1000
disposable
required
boolean
holdDays
required
integer format: int64
Allowed values: 0 3 7 14 30
left
required
boolean
numbered
required
boolean
sameIp
required
boolean
sharedIp
required
object
on
required
boolean
threshold
required
integer format: int64
>= 1 <= 1000

OK

Media typeapplication/json
object
awaiting
required
integer format: int64
holdFrom
required
integer format: int64
holdTo
required
integer format: int64
inHold
required
integer format: int64
rulesChanged
required
Array<string>

Example generated

{
"awaiting": 1,
"holdFrom": 1,
"holdTo": 1,
"inHold": 1,
"rulesChanged": [
"example"
]
}

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