Skip to content

Change the auto-pause thresholds or the schedule

PATCH
/api/v1/workspaces/{workspace}/campaigns/{campaignId}/send-settings
curl --request PATCH \
--url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/send-settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "schedule": { "date": "example", "mode": "now", "time": "example", "timezone": "example" }, "thresholds": { "bounce": 1, "complaint": 1, "mailboxComplaint": 1, "providerErrors": 1, "scope": "route" } }'

Permission: campaigns:edit

The schedule is part of what an approval covers: changing it invalidates the approval.

workspace
required

Workspace slug

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

Workspace slug

campaignId
required
string format: uuid
Media typeapplication/json
object
schedule
object
at
string format: date-time
date
string
/^\d{4}-\d{2}-\d{2}$/
mode
required
string
Allowed values: now at best_time
time
string
/^([01]\d|2[0-3]):[0-5]\d$/
timezone
string
<= 64 characters
thresholds
object
bounce
required
number format: double
>= 0.1 <= 20
complaint
required
number format: double
>= 0.01 <= 5
mailboxComplaint
required
number format: double
>= 0.01 <= 5
providerErrors
required
number format: double
>= 1 <= 100
scope
required
string
Allowed values: route campaign

No Content

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