Update follow-up settings
Changes the time of day and time zone for follow-up messages, and the own time of single steps. Does not send anything. Returns the settings.
PATCH /v1/followup-settings
| Permission | settings:write (all permissions) |
| Risk | Write (no outside effect) |
| Idempotency-Key | Optional (how it works) |
| Safe to repeat | Safe by nature. With the same Idempotency-Key the first answer comes back. |
| Rate limit class | write (120 requests per minute per key) |
| Confirmation | None |
| MCP tool | Not available in MCP |
| Since version | 2026-10-25 |
#What it does
- Changes data in your account. It does not send messages to contacts.
- Safe to repeat. With the same Idempotency-Key the first answer comes back.
#Request
Header
| Name | Required | Description |
|---|---|---|
Authorization | yes | Bearer <key> |
Idempotency-Key | no | A unique value for this operation, for example a UUID (1 to 255 visible ASCII characters). |
Body (JSON)
| Name | Type | Required | Description |
|---|---|---|---|
send_time | string or null | no | Time of day as HH:MM, for example 09:30. Null removes it. |
timezone | string or null | no | Time zone name such as Europe/Berlin. Null removes it. up to 60 characters |
steps | array of object | no | Own time of day for single steps. up to 100 items |
steps[].step_id | string | yes | Step ID. |
steps[].send_time | string or null | yes | Time of day as HH:MM, for example 09:30. Null removes it. |
#Examples
curl -X PATCH "https://api.smartchat.marketing/v1/followup-settings" \
-H "Authorization: Bearer $SMARTCHAT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"send_time": "09:30",
"timezone": "Europe/Berlin"
}'import os
import requests
response = requests.patch(
"https://api.smartchat.marketing/v1/followup-settings",
headers={"Authorization": "Bearer " + os.environ["SMARTCHAT_API_KEY"]},
json={
"send_time": "09:30",
"timezone": "Europe/Berlin",
},
)
response.raise_for_status()
print(response.json())const response = await fetch("https://api.smartchat.marketing/v1/followup-settings", {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.SMARTCHAT_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"send_time": "09:30",
"timezone": "Europe/Berlin"
}),
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());Response (200):
{
"object": "followup_settings",
"send_time": "09:30",
"timezone": "Europe/Berlin",
"default_timezone": "Europe/Zurich",
"steps": [
{
"step_id": "stp_1a2b3c4d5e6f47a8b9c0d1e2f3a4b5c6",
"position": 1,
"delay_minutes": 1440,
"send_time": null
}
]
}#Response
Status 200. Every response has the headers Request-Id, SmartChat-Version and X-RateLimit-*.
| Name | Type | Description |
|---|---|---|
object | string | Always "followup_settings". always followup_settings |
send_time | string or null | Local time of day (in the account time zone) as HH:MM for all follow-up steps, or null for no fixed time. |
timezone | string or null | Time zone name such as Europe/Berlin, or null for the default. up to 60 characters |
default_timezone | string | Time zone used when timezone is null. up to 60 characters |
steps | array of object | Steps of the sign-up sequences with their own time of day. up to 100 items |
steps[].step_id | string | Step ID. |
steps[].position | integer | Order of the step. 1 to 100 |
steps[].delay_minutes | integer | Wait before the step in minutes. 0 to 525600 |
steps[].send_time | string or null | Own local time of day as HH:MM for this step, or null. |
#Errors
| Code | Status | When |
|---|---|---|
bad_request | 400 | The request could not be read. |
missing_parameter | 400 | A required field is missing. |
unknown_parameter | 400 | A field is not known. |
api_key_expired | 401 | This API key has expired. |
api_key_invalid | 401 | This API key is not valid. |
api_key_revoked | 401 | This API key was revoked. |
authentication_required | 401 | No API key was sent. Send 'Authorization: Bearer <key>'. |
account_blocked | 403 | This account is blocked. |
insufficient_scope | 403 | This key lacks a required permission. |
ip_not_allowed | 403 | This IP address is not allowed for this key. |
step_not_found | 404 | No follow-up step with this ID exists in this account. |
validation_failed | 422 | A field is not valid. |
rate_limited | 429 | Too many requests. Wait and try again. |
internal_error | 500 | Something went wrong on our side. |
service_unavailable | 503 | The service is temporarily unavailable. |
All errors use one format.