Change a scheduled message or when it goes

PATCH

/v1/scheduled-messages/{id}

curl --request PATCH \
  --url https://api.threadkite.app/v1/scheduled-messages/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "subject": "example", "text": "example", "html": "example", "sendAt": "2026-04-15T12:00:00Z", "cancelOnReply": true }'

• Threadkite API

While it is waiting (or after it failed: a new time makes it wait again).

Authorizations

• api_key
  messages:write

Parameters

Path Parameters

id

required

string format: uuid

Request Body^required

Media typeapplication/json

object

subject

string

nullable <= 500 characters

text

string

>= 1 characters <= 50000 characters

html

string

nullable <= 500000 characters

sendAt

string format: date-time

cancelOnReply

boolean

Example ^generated

{
  "subject": "example",
  "text": "example",
  "html": "example",
  "sendAt": "2026-04-15T12:00:00Z",
  "cancelOnReply": true
}

Responses

200

Media typeapplication/json

object

id

required

string format: uuid

threadId

required

string format: uuid

author

required

One of:

object

object

id

required

string

name

required

string

channel

required

string

Allowed values: email sms whatsapp chat marketplace messenger instagram

subject

required

string

nullable

text

required

string

html

required

string

nullable

attachmentCount

required

How many files are attached

number

usesTemplate

required

A WhatsApp template is used

boolean

sendAt

required

string format: date-time

cancelOnReply

required

boolean

status

required

string

Allowed values: pending sending sent cancelled failed

messageId

required

Once sent

string format: uuid

nullable

failureReason

required

Why it wasn’t sent, when it failed

string

nullable

cancelledReason

required

string

nullable

Allowed values: contact_replied cancelled

sentAt

required

string format: date-time

nullable

canEdit

required

You can change, send now or cancel it

boolean

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "author": {
    "id": "usr_8f2c",
    "name": "James Patel"
  },
  "channel": "email",
  "status": "pending",
  "failureReason": "They have opted out of texts.",
  "cancelledReason": "contact_replied"
}

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

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

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

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

404

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

409

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

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
}