Skip to content
ThreadkiteThreadkite Docs

Change automation settings, or pause every automation

PATCH
/v1/flow-settings
curl --request PATCH \
  --url https://api.threadkite.app/v1/flow-settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "sendWindow": { "from": "08:00", "to": "20:00", "days": [ "monday" ] }, "frequencyCap": 1, "pauseAll": true }'

The send window must be within 8am to 9pm. pauseAll: true stops every automation until it is set back to false.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
sendWindow
object
from
required

Not before 08:00

string

Example 

08:00
to
required

Not after 21:00

string

Example 

20:00
days
required
Array<string>
Allowed values: monday tuesday wednesday thursday friday saturday sunday
frequencyCap
integer
>= 1 <= 20
pauseAll

Pause every automation (nothing moves on, nobody new starts), or carry on

boolean

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
sendWindow
required

Marketing messages from automations only go between these times on these days, in the contact’s time zone (the location’s when unknown)

object
from
required

Not before 08:00

string
to
required

Not after 21:00

string
days
required
Array<string>
Allowed values: monday tuesday wednesday thursday friday saturday sunday
frequencyCap
required

Most marketing messages from automations to one contact in 7 days

number
>= 1 <= 20
pausedAll
required

Every automation is paused

boolean
pausedAt
required
string format: date-time
nullable

Example 

{
  "sendWindow": {
    "from": "08:00",
    "to": "20:00",
    "days": [
      "monday"
    ]
  }
}

400

Section titled “400”
Media typeapplication/json
object
statusCode
required
number
code
required

Stable machine-readable reason

string
message
required
string
errors

With code invalid: every problem with the request, by field (message is the first)

Array<object>
object
path
required

Dotted path inside the item, e.g. attributes.price.amountMinor

string
message
required
string

Example 

{
  "statusCode": 403,
  "code": "forbidden",
  "message": "You do not have permission to do that.",
  "errors": [
    {
      "message": "Enter the make"
    }
  ]
}

401

Section titled “401”

Missing or invalid API key

Media typeapplication/json
object
statusCode
required
number
code
required

Stable machine-readable reason

string
message
required
string
errors

With code invalid: every problem with the request, by field (message is the first)

Array<object>
object
path
required

Dotted path inside the item, e.g. attributes.price.amountMinor

string
message
required
string

Example 

{
  "statusCode": 403,
  "code": "forbidden",
  "message": "You do not have permission to do that.",
  "errors": [
    {
      "message": "Enter the make"
    }
  ]
}

402

Section titled “402”

The organisation is on the Free plan (code upgrade_required)

Media typeapplication/json
object
statusCode
required
number
code
required

Stable machine-readable reason

string
message
required
string
feature
required

The feature that needs Pro

string
nullable
Allowed values: extraSeats connections aiAssistant aiReplies rules fullReports api inboxes bulkMessages videoMessages
upgradePath
required

Where to upgrade or pay, in the web app

string

Example 

{
  "statusCode": 402,
  "code": "upgrade_required",
  "message": "Connections are part of Pro. Upgrade to connect texts, calls and more.",
  "feature": "extraSeats",
  "upgradePath": "/settings/billing"
}

403

Section titled “403”

The key does not have the scope (or the person the permission)

Media typeapplication/json
object
statusCode
required
number
code
required

Stable machine-readable reason

string
message
required
string
errors

With code invalid: every problem with the request, by field (message is the first)

Array<object>
object
path
required

Dotted path inside the item, e.g. attributes.price.amountMinor

string
message
required
string

Example 

{
  "statusCode": 403,
  "code": "forbidden",
  "message": "You do not have permission to do that.",
  "errors": [
    {
      "message": "Enter the make"
    }
  ]
}

429

Section titled “429”

Rate limit reached

Media typeapplication/json
object
statusCode
required
number
code
required

Stable machine-readable reason

string
message
required
string
retryAfter
required

Seconds until another request will be accepted

number

Example 

{
  "statusCode": 429,
  "code": "rate_limited",
  "message": "Too many requests. Each key can make 120 requests a minute; try again in 12 seconds.",
  "retryAfter": 12
}