{
"code": "RATE_LIMIT_ERROR",
"message": "You can only make 100 requests per second",
"status": 429
}
{
"code": "UNKNOWN_ERROR",
"message": "Internal server error",
"status": 500
}
Authorizations
Authorization
string
header
required
Your Periskope API token, sent as Authorization: Bearer <token>. Generate one from the Periskope dashboard under Settings → API & Webhooks. API access requires an active Pro or Enterprise plan.
Path Parameters
scheduled_id
string
required
Id of the scheduled message — the scheduled_id returned when it was created
Minimum string length: 1
Example:
"00000000-0000-0000-0000-000000000000"
Body
application/json
message
string
New text content. The stored attachment is kept unless media is also sent.
Example:
"Updated reminder: submit your report by EOD"
media
object | null
New attachment. Pass null to remove the current attachment.
Show child attributes
scheduled_at
string
When to send (the first run for repeating messages), as an ISO 8601 timestamp in the future. Send it in UTC (e.g. 2026-02-01T09:00:00Z); recurrence for repeating messages is computed in UTC.
Example:
"2026-02-01T09:00:00Z"
is_repeat
boolean
Turn repetition on (requires a repeat_config with repeat_interval, sent now or already stored) or off (clears repeat_config).
Example:
true
repeat_config
object | null
New repeat configuration. Replaces the stored repeat_config as a whole — fields not included are cleared, not kept — so always send the complete desired config (repeat_interval plus any repeat_value, repeat_days or repeat_ends you want to retain). Pass null together with is_repeat false to stop the series.
Show child attributes
paused
boolean
true pauses the schedule (runs are skipped, the series keeps advancing); false resumes it.
Example:
true
skip_next
boolean
true skips the next run once; the series then continues.
Example:
false
Response
The updated scheduled message
A scheduled message — content sent to a chat at scheduled_at, once or on a repeating series
scheduled_id
string
Unique id of the scheduled message
Example:
"00000000-0000-0000-0000-000000000000"
org_id
string
Id of the organization the scheduled message belongs to
Example:
"00000000-0000-0000-0000-000000000000"
org_phone
string
Org phone (WhatsApp account) the message is sent from, as country code + number suffixed with @c.us
Example:
"911111111111@c.us"
chat_id
string
Chat the message is sent to — @c.us for 1-1 chats, @g.us for group chats
Example:
"120363000000000000@g.us"
message_payload
object
Content sent on every run — same shape as POST /message/send
Show child attributes
scheduled_at
string
When the next run happens, as an ISO 8601 timestamp. For repeating messages this advances after every run.
Example:
"2026-02-01T09:00:00.000Z"
is_repeat
boolean
Whether the message repeats or sends once
Example:
true
repeat_config
object
How the message recurs. null for one-time messages.
Show child attributes
status
enum<string>
Lifecycle status: 'scheduled' (waiting for the next run), 'paused' (runs are skipped) or 'completed'
Available options:
scheduled,
paused,
completed
Example:
"scheduled"
skip_next
boolean
When true, the next run is skipped once and the series continues
Example:
false
paused_at
string
When the schedule was paused, as an ISO 8601 timestamp. null while not paused.
updated_at
string
When the schedule completed (one-time message sent, or series ended), as an ISO 8601 timestamp. null while pending.
performed_by
string
Who created the schedule: a member email, or "api"
Example:
"api"
created_at
string
When the schedule was created, as an ISO 8601 timestamp
Example:
"2026-01-15T09:30:00.000Z"
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Periskope Docs","colors":{"primary":"#15803D","light":"#15803D"},"logo":{"light":"https://mintcdn.com/bharatkumarramesh/Sq5VlnE2OgDOCH8s/logo/periskope-logo-full.svg?fit=max\u0026auto=format\u0026n=Sq5VlnE2OgDOCH8s\u0026q=85\u0026s=cace2e822ea7c0cd2a98b9d946baa593","dark":"https://mintcdn.com/bharatkumarramesh/Sq5VlnE2OgDOCH8s/logo/periskope-logo-full.svg?fit=max\u0026auto=format\u0026n=Sq5VlnE2OgDOCH8s\u0026q=85\u0026s=cace2e822ea7c0cd2a98b9d946baa593"},"favicon":"https://mintcdn.com/bharatkumarramesh/4Au0rGi6EzWXLRIt/logo/periskope-logo.svg?fit=max\u0026auto=format\u0026n=4Au0rGi6EzWXLRIt\u0026q=85\u0026s=275c52e578008a630d9a4c6e150100a0","api":{"playground":{"display":"none"}},"appearance":{"strict":true},"navbar":{"links":[{"href":"https://www.postman.com/periskope/workspace/periskope-platform-api","label":"Postman API collection"},{"href":"https://what.sapp.link/periskope","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://console.periskope.app"}},"footer":{"socials":{"twitter":"https://twitter.com/periskope_app","linkedin":"https://www.linkedin.com/company/periskope-app","youtube":"https://www.youtube.com/@PeriskopeApp"}},"integrations":{"gtm":{"tagId":"GTM-N9SPZLGR"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"bharatkumarramesh","hasAudioNarration":false,"actualSubdomain":"bharatkumarramesh","customDomains":["docs.periskope.app"],"gitSource":{"type":"github","owner":"periskope-org","repo":"docs-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6afd3d11e5291c07d426c387","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"APIs \u0026 Webhooks","count":136},{"language":"default","tag":"Documentation","count":69},{"language":"default","tag":"Webhooks","count":21},{"language":"default","tag":"API","count":14},{"language":"default","tag":"Message APIs","count":14},{"language":"default","tag":"Chat APIs","count":13},{"language":"default","tag":"AI Agent","count":12},{"language":"default","tag":"Manage WhatsApp Groups, 1:1 Chats \u0026 Communities","count":11},{"language":"default","tag":"Objects","count":10},{"language":"default","tag":"Group Settings APIs","count":9}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".image-container{max-width:50%;margin:0 auto}"}],"page":{"pagePath":"api-reference/scheduled-messages/update-scheduled-message","slug":"/api-reference/scheduled-messages/update-scheduled-message","pageMetadata":{"title":"Update Scheduled Message","openapi":"api-reference/openapi-generated.json PATCH /v1/message/scheduled/{scheduled_id}","description":"Updates a pending scheduled message — content, next run time, repetition, pause/resume or skip-next. Completed messages cannot be updated.","href":"/api-reference/scheduled-messages/update-scheduled-message"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Updates a pending scheduled message — content, next run time, repetition, pause/resume or skip-next. Completed messages cannot be updated.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update Scheduled Message","openapi":"api-reference/openapi-generated.json PATCH /v1/message/scheduled/{scheduled_id}","description":"Updates a pending scheduled message — content, next run time, repetition, pause/resume or skip-next. Completed messages cannot be updated.","href":"/api-reference/scheduled-messages/update-scheduled-message"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"updateScheduledMessage","summary":"Update a scheduled message","description":"Updates a pending scheduled message — content, next run time, repetition, pause/resume or skip-next. Completed messages cannot be updated.","tags":["Scheduled Messages"],"security":["e77b596f-668c-4c10-b4ac-4fbef442d122"],"parameters":["e4746683-7241-4ae3-ace5-03d96c72f889"],"requestBody":"1d2ebc7d-cc43-4824-97ee-08d3bf423248","responses":{"200":"f8475ec4-30e7-4d63-9219-755ad20b521a","401":"a084928a-0136-483f-9af5-0e6e12af117b","404":"c595cee4-bbd8-4a88-b4cd-f3cdc713f3b1","422":"1615c8c0-284e-4b69-977b-62c72bc90b8e","429":"b57c85f8-374f-4090-a63c-c5cb3b626a4e","500":"5d9a9181-bc2d-440d-a4aa-ea1b9d9c5587"},"x-codeSamples":[{"lang":"typescript","label":"TypeScript","source":"import { PeriskopeApi } from '@periskope/periskope-client';\n\nconst client = new PeriskopeApi({\n authToken: 'YOUR_API_KEY',\n});\n\nasync function main() {\n const response = await client.scheduledMessages.updateScheduledMessage({\n scheduled_id: '00000000-0000-0000-0000-000000000000',\n message: 'Updated reminder: submit your report by EOD',\n });\n console.log(response);\n}\n\nmain();"},{"lang":"bash","label":"cURL","source":"curl -X PATCH 'https://api.periskope.app/v1/message/scheduled/00000000-0000-0000-0000-000000000000' \\\n -H 'Authorization: Bearer YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"message\": \"Updated reminder: submit your report by EOD\"\n }'"}],"method":"patch","type":"path","servers":["09897b52-aa53-4c89-80d0-59fbc0f457de"],"path":"/v1/message/scheduled/{scheduled_id}","baseUrlOptions":["https://api.periskope.app"],"title":"Update a scheduled message","codeSamples":[{"label":"TypeScript","lang":"typescript","source":"import { PeriskopeApi } from '@periskope/periskope-client';\n\nconst client = new PeriskopeApi({\n authToken: 'YOUR_API_KEY',\n});\n\nasync function main() {\n const response = await client.scheduledMessages.updateScheduledMessage({\n scheduled_id: '00000000-0000-0000-0000-000000000000',\n message: 'Updated reminder: submit your report by EOD',\n });\n console.log(response);\n}\n\nmain();"},{"label":"cURL","lang":"bash","source":"curl -X PATCH 'https://api.periskope.app/v1/message/scheduled/00000000-0000-0000-0000-000000000000' \\\n -H 'Authorization: Bearer YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"message\": \"Updated reminder: submit your report by EOD\"\n }'"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"e4746683-7241-4ae3-ace5-03d96c72f889":{"schema":{"type":"string","minLength":1,"description":"Id of the scheduled message — the scheduled_id returned when it was created","example":"00000000-0000-0000-0000-000000000000","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"description":"Id of the scheduled message — the scheduled_id returned when it was created","name":"scheduled_id","in":"path"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"New text content. The stored attachment is kept unless media is also sent.","example":"Updated reminder: submit your report by EOD","uniqueKey":"message","typeLabel":"string"},"media":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["image","video","document","audio","ptt"],"description":"Kind of media being sent: 'image', 'video', 'document', 'audio', or 'ptt' (push-to-talk voice note). Determines the message_type of the resulting message.","example":"image","isRequired":true,"uniqueKey":"media.oneOf.0.type","typeLabel":"enum\u003cstring>"},"url":{"type":"string","description":"Publicly accessible URL that hosts the content to be sent. Provide either url or filedata, not both.","example":"https://example.com/files/image.png","uniqueKey":"media.oneOf.0.url","typeLabel":"string"},"filedata":{"type":"string","description":"Raw bytes of the file, encoded as base64. Alternative to url — provide either url or filedata, not both.","example":"iVBORw0KGgoAAAANSUhEUgAA...","uniqueKey":"media.oneOf.0.filedata","typeLabel":"string"},"mimetype":{"type":"string","description":"MIME type of the media file (e.g. image/png, video/mp4, text/csv). Recommended when sending filedata.","example":"image/png","uniqueKey":"media.oneOf.0.mimetype","typeLabel":"string"},"filename":{"type":"string","description":"Filename of the media, shown in the chat (mainly relevant for document messages). Defaults to the last path segment of url.","example":"image.png","uniqueKey":"media.oneOf.0.filename","typeLabel":"string"}},"required":["type"],"description":"New attachment. Pass null to remove the current attachment.","uniqueKey":"media.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"type":{"type":"string","enum":["image","video","document","audio","ptt"],"description":"Kind of media being sent: 'image', 'video', 'document', 'audio', or 'ptt' (push-to-talk voice note). Determines the message_type of the resulting message.","example":"image"},"url":{"type":"string","description":"Publicly accessible URL that hosts the content to be sent. Provide either url or filedata, not both.","example":"https://example.com/files/image.png"},"filedata":{"type":"string","description":"Raw bytes of the file, encoded as base64. Alternative to url — provide either url or filedata, not both.","example":"iVBORw0KGgoAAAANSUhEUgAA..."},"mimetype":{"type":"string","description":"MIME type of the media file (e.g. image/png, video/mp4, text/csv). Recommended when sending filedata.","example":"image/png"},"filename":{"type":"string","description":"Filename of the media, shown in the chat (mainly relevant for document messages). Defaults to the last path segment of url.","example":"image.png"}},"required":["type"],"description":"New attachment. Pass null to remove the current attachment.","uniqueKey":"media.oneOf.1","typeLabel":"null"}],"uniqueKey":"media","typeLabel":"object | null"},"scheduled_at":{"type":"string","description":"When to send (the first run for repeating messages), as an ISO 8601 timestamp in the future. Send it in UTC (e.g. 2026-02-01T09:00:00Z); recurrence for repeating messages is computed in UTC.","example":"2026-02-01T09:00:00Z","uniqueKey":"scheduled_at","typeLabel":"string"},"is_repeat":{"type":"boolean","description":"Turn repetition on (requires a repeat_config with repeat_interval, sent now or already stored) or off (clears repeat_config).","example":true,"uniqueKey":"is_repeat","typeLabel":"boolean"},"repeat_config":{"oneOf":[{"type":"object","properties":{"repeat_interval":{"type":"string","enum":["day","week","month"],"description":"Unit of repetition: 'day', 'week' or 'month'. Required for repeating messages.","example":"week","uniqueKey":"repeat_config.oneOf.0.repeat_interval","typeLabel":"enum\u003cstring>"},"repeat_value":{"type":"integer","minimum":1,"description":"Every how many intervals between runs, e.g. 2 with repeat_interval week = every 2 weeks. Defaults to 1. Not applied when repeat_days is set — the schedule then runs on the listed weekdays instead.","example":1,"uniqueKey":"repeat_config.oneOf.0.repeat_value","typeLabel":"integer"},"repeat_days":{"type":"array","items":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"uniqueKey":"repeat_config.oneOf.0.repeat_days.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Only for repeat_interval 'day': restrict runs to these weekdays, e.g. ['monday', 'friday']. The schedule then runs on each listed weekday (repeat_value is ignored). Empty or omitted allows every day. Not allowed for 'week' or 'month' intervals.","example":["monday","friday"],"uniqueKey":"repeat_config.oneOf.0.repeat_days","typeLabel":"enum\u003cstring>[]"},"repeat_ends":{"type":"string","description":"When the series stops, as an ISO 8601 UTC timestamp. The series ends once the next run would fall after this time. Omit for no end date.","example":"2026-12-31T00:00:00Z","uniqueKey":"repeat_config.oneOf.0.repeat_ends","typeLabel":"string"}},"description":"New repeat configuration. Replaces the stored repeat_config as a whole — fields not included are cleared, not kept — so always send the complete desired config (repeat_interval plus any repeat_value, repeat_days or repeat_ends you want to retain). Pass null together with is_repeat false to stop the series.","uniqueKey":"repeat_config.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"repeat_interval":{"type":"string","enum":["day","week","month"],"description":"Unit of repetition: 'day', 'week' or 'month'. Required for repeating messages.","example":"week"},"repeat_value":{"type":"integer","minimum":1,"description":"Every how many intervals between runs, e.g. 2 with repeat_interval week = every 2 weeks. Defaults to 1. Not applied when repeat_days is set — the schedule then runs on the listed weekdays instead.","example":1},"repeat_days":{"type":"array","items":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"description":"Only for repeat_interval 'day': restrict runs to these weekdays, e.g. ['monday', 'friday']. The schedule then runs on each listed weekday (repeat_value is ignored). Empty or omitted allows every day. Not allowed for 'week' or 'month' intervals.","example":["monday","friday"]},"repeat_ends":{"type":"string","description":"When the series stops, as an ISO 8601 UTC timestamp. The series ends once the next run would fall after this time. Omit for no end date.","example":"2026-12-31T00:00:00Z"}},"description":"New repeat configuration. Replaces the stored repeat_config as a whole — fields not included are cleared, not kept — so always send the complete desired config (repeat_interval plus any repeat_value, repeat_days or repeat_ends you want to retain). Pass null together with is_repeat false to stop the series.","uniqueKey":"repeat_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"repeat_config","typeLabel":"object | null"},"paused":{"type":"boolean","description":"true pauses the schedule (runs are skipped, the series keeps advancing); false resumes it.","example":true,"uniqueKey":"paused","typeLabel":"boolean"},"skip_next":{"type":"boolean","description":"true skips the next run once; the series then continues.","example":false,"uniqueKey":"skip_next","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Updated reminder: submit your report by EOD","media":{"type":"image","url":"https://example.com/files/image.png","filedata":"iVBORw0KGgoAAAANSUhEUgAA...","mimetype":"image/png","filename":"image.png"},"scheduled_at":"2026-02-01T09:00:00Z","is_repeat":true,"repeat_config":{"repeat_interval":"week","repeat_value":1,"repeat_days":["monday","friday"],"repeat_ends":"2026-12-31T00:00:00Z"},"paused":true,"skip_next":false}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"f8475ec4-30e7-4d63-9219-755ad20b521a":{"description":"The updated scheduled message","content":{"application/json":{"schema":{"type":"object","properties":{"scheduled_id":{"type":"string","description":"Unique id of the scheduled message","example":"00000000-0000-0000-0000-000000000000","uniqueKey":"scheduled_id","typeLabel":"string"},"org_id":{"type":"string","description":"Id of the organization the scheduled message belongs to","example":"00000000-0000-0000-0000-000000000000","uniqueKey":"org_id","typeLabel":"string"},"org_phone":{"type":"string","description":"Org phone (WhatsApp account) the message is sent from, as country code + number suffixed with @c.us","example":"911111111111@c.us","uniqueKey":"org_phone","typeLabel":"string"},"chat_id":{"type":"string","description":"Chat the message is sent to — \u003ccountrycode>\u003cnumber>@c.us for 1-1 chats, \u003cgroup-id>@g.us for group chats","example":"120363000000000000@g.us","uniqueKey":"chat_id","typeLabel":"string"},"message_payload":{"type":"object","properties":{"message":{"type":"string","description":"Text content of the scheduled message","example":"Weekly reminder: submit your report","uniqueKey":"message_payload.message","typeLabel":"string"},"media":{"type":"object","description":"Attachment of the scheduled message, when present","uniqueKey":"message_payload.media","typeLabel":"object"}},"description":"Content sent on every run — same shape as POST /message/send","uniqueKey":"message_payload","typeLabel":"object"},"scheduled_at":{"type":"string","description":"When the next run happens, as an ISO 8601 timestamp. For repeating messages this advances after every run.","example":"2026-02-01T09:00:00.000Z","uniqueKey":"scheduled_at","typeLabel":"string"},"is_repeat":{"type":"boolean","description":"Whether the message repeats or sends once","example":true,"uniqueKey":"is_repeat","typeLabel":"boolean"},"repeat_config":{"type":"object","properties":{"repeat_interval":{"type":"string","enum":["day","week","month"],"description":"Unit of repetition: 'day', 'week' or 'month'. Required for repeating messages.","example":"week","uniqueKey":"repeat_config.repeat_interval","typeLabel":"enum\u003cstring>"},"repeat_value":{"type":"integer","minimum":1,"description":"Every how many intervals between runs, e.g. 2 with repeat_interval week = every 2 weeks. Defaults to 1. Not applied when repeat_days is set — the schedule then runs on the listed weekdays instead.","example":1,"uniqueKey":"repeat_config.repeat_value","typeLabel":"integer"},"repeat_days":{"type":"array","items":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"uniqueKey":"repeat_config.repeat_days.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Only for repeat_interval 'day': restrict runs to these weekdays, e.g. ['monday', 'friday']. The schedule then runs on each listed weekday (repeat_value is ignored). Empty or omitted allows every day. Not allowed for 'week' or 'month' intervals.","example":["monday","friday"],"uniqueKey":"repeat_config.repeat_days","typeLabel":"enum\u003cstring>[]"},"repeat_ends":{"type":"string","description":"When the series stops, as an ISO 8601 UTC timestamp. The series ends once the next run would fall after this time. Omit for no end date.","example":"2026-12-31T00:00:00Z","uniqueKey":"repeat_config.repeat_ends","typeLabel":"string"}},"description":"How the message recurs. null for one-time messages.","uniqueKey":"repeat_config","typeLabel":"object"},"status":{"type":"string","enum":["scheduled","paused","completed"],"description":"Lifecycle status: 'scheduled' (waiting for the next run), 'paused' (runs are skipped) or 'completed'","example":"scheduled","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"skip_next":{"type":"boolean","description":"When true, the next run is skipped once and the series continues","example":false,"uniqueKey":"skip_next","typeLabel":"boolean"},"paused_at":{"type":"string","description":"When the schedule was paused, as an ISO 8601 timestamp. null while not paused.","uniqueKey":"paused_at","typeLabel":"string"},"updated_at":{"type":"string","description":"When the schedule completed (one-time message sent, or series ended), as an ISO 8601 timestamp. null while pending.","uniqueKey":"updated_at","typeLabel":"string"},"performed_by":{"type":"string","description":"Who created the schedule: a member email, or \"api\"","example":"api","uniqueKey":"performed_by","typeLabel":"string"},"created_at":{"type":"string","description":"When the schedule was created, as an ISO 8601 timestamp","example":"2026-01-15T09:30:00.000Z","uniqueKey":"created_at","typeLabel":"string"}},"description":"A scheduled message — content sent to a chat at scheduled_at, once or on a repeating series","uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","summary":"Response body","value":{"scheduled_id":"00000000-0000-0000-0000-000000000000","org_id":"00000000-0000-0000-0000-000000000000","org_phone":"911111111111@c.us","chat_id":"120363000000000000@g.us","message_payload":{"message":"Weekly reminder: submit your report","media":{}},"scheduled_at":"2026-02-01T09:00:00.000Z","is_repeat":true,"repeat_config":{"repeat_interval":"week","repeat_value":1,"repeat_days":["monday","friday"],"repeat_ends":"2026-12-31T00:00:00Z"},"status":"scheduled","skip_next":false,"paused_at":null,"updated_at":null,"performed_by":"api","created_at":"2026-01-15T09:30:00.000Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"a084928a-0136-483f-9af5-0e6e12af117b":{"description":"Invalid, expired or missing API token","content":{"application/json":{"examples":{"error":{"title":"error","summary":"Invalid, expired or missing API token","value":{"code":"UNAUTHORIZED_ERROR","message":"Invalid bearer auth token","status":401}}},"schema":{"type":"object","properties":{"code":{"type":"string","example":"UNAUTHORIZED_ERROR","uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","example":"Invalid bearer auth token","uniqueKey":"message","typeLabel":"string"},"status":{"type":"integer","example":401,"uniqueKey":"status","typeLabel":"integer"}},"example":{"code":"UNAUTHORIZED_ERROR","message":"Invalid bearer auth token","status":401},"uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"exampleType":"examples"},"c595cee4-bbd8-4a88-b4cd-f3cdc713f3b1":{"description":"Scheduled message not found","content":{"application/json":{"examples":{"error":{"title":"error","summary":"Scheduled message not found","value":{"code":"NOT_FOUND_ERROR","message":"Scheduled message not found","status":404}}},"schema":{"type":"object","properties":{"code":{"type":"string","example":"NOT_FOUND_ERROR","uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","example":"Scheduled message not found","uniqueKey":"message","typeLabel":"string"},"status":{"type":"integer","example":404,"uniqueKey":"status","typeLabel":"integer"}},"example":{"code":"NOT_FOUND_ERROR","message":"Scheduled message not found","status":404},"uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"exampleType":"examples"},"1615c8c0-284e-4b69-977b-62c72bc90b8e":{"description":"Request validation failed","content":{"application/json":{"examples":{"error":{"title":"error","summary":"Request validation failed","value":{"code":"VALIDATION_ERROR","message":"Request validation failed","status":422,"fields":{"body.chat_id":{"message":"chat_id is required"}}}}},"schema":{"type":"object","properties":{"code":{"type":"string","example":"VALIDATION_ERROR","uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","example":"Request validation failed","uniqueKey":"message","typeLabel":"string"},"status":{"type":"integer","example":422,"uniqueKey":"status","typeLabel":"integer"},"fields":{"type":"object","additionalProperties":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"fields.additionalProperties.message","typeLabel":"string"},"value":{"oneOf":[{}],"uniqueKey":"fields.additionalProperties.value","typeLabel":"any"}},"uniqueKey":"fields.additionalProperties","typeLabel":"object"},"example":{"body.chat_id":{"message":"chat_id is required"}},"uniqueKey":"fields","typeLabel":"object"}},"example":{"code":"VALIDATION_ERROR","message":"Request validation failed","status":422,"fields":{"body.chat_id":{"message":"chat_id is required"}}},"uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"exampleType":"examples"},"b57c85f8-374f-4090-a63c-c5cb3b626a4e":{"description":"Rate limit exceeded","content":{"application/json":{"examples":{"error":{"title":"error","summary":"Rate limit exceeded","value":{"code":"RATE_LIMIT_ERROR","message":"You can only make 100 requests per second","status":429}}},"schema":{"type":"object","properties":{"code":{"type":"string","example":"RATE_LIMIT_ERROR","uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","example":"You can only make 100 requests per second","uniqueKey":"message","typeLabel":"string"},"status":{"type":"integer","example":429,"uniqueKey":"status","typeLabel":"integer"}},"example":{"code":"RATE_LIMIT_ERROR","message":"You can only make 100 requests per second","status":429},"uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"exampleType":"examples"},"5d9a9181-bc2d-440d-a4aa-ea1b9d9c5587":{"description":"Internal server error","content":{"application/json":{"examples":{"error":{"title":"error","summary":"Internal server error","value":{"code":"UNKNOWN_ERROR","message":"Internal server error","status":500}}},"schema":{"type":"object","properties":{"code":{"type":"string","example":"UNKNOWN_ERROR","uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","example":"Internal server error","uniqueKey":"message","typeLabel":"string"},"status":{"type":"integer","example":500,"uniqueKey":"status","typeLabel":"integer"}},"example":{"code":"UNKNOWN_ERROR","message":"Internal server error","status":500},"uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"e77b596f-668c-4c10-b4ac-4fbef442d122":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Your Periskope API token, sent as `Authorization: Bearer \u003ctoken>`. Generate one from the Periskope dashboard under **Settings → API \u0026 Webhooks**. API access requires an active Pro or Enterprise plan.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"09897b52-aa53-4c89-80d0-59fbc0f457de":{"url":"https://api.periskope.app"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Your Periskope API token, sent as `Authorization: Bearer \u003ctoken>`. Generate one from the Periskope dashboard under **Settings → API \u0026 Webhooks**. API access requires an active Pro or Enterprise plan.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your Periskope API token, sent as `Authorization: Bearer \u003ctoken>`. Generate one from the Periskope dashboard under **Settings → API \u0026 Webhooks**. API access requires an active Pro or Enterprise plan.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi-generated.json"},"subdomain":"bharatkumarramesh","siteName":"Periskope Docs","title":"Update Scheduled Message - Periskope Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-25T16:09:26.374Z","originalFileLocation":"api-reference/scheduled-messages/update-scheduled-message.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Updates a pending scheduled message — content, next run time, repetition, pause/resume or skip-next. Completed messages cannot be updated.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Periskope Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/bharatkumarramesh/xEFzGZM_csru_Nms/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/bharatkumarramesh/xEFzGZM_csru_Nms/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/bharatkumarramesh/xEFzGZM_csru_Nms/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/bharatkumarramesh/xEFzGZM_csru_Nms/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/bharatkumarramesh/xEFzGZM_csru_Nms/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/bharatkumarramesh/xEFzGZM_csru_Nms/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/bharatkumarramesh/xEFzGZM_csru_Nms/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/bharatkumarramesh/xEFzGZM_csru_Nms/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/bharatkumarramesh/xEFzGZM_csru_Nms/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update Scheduled Message - Periskope Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates a pending scheduled message — content, next run time, repetition, pause/resume or skip-next. Completed messages cannot be updated.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Periskope Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.periskope.app/api-reference/scheduled-messages/update-scheduled-message\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://bharatkumarramesh.mintlify.site/_mintlify/api/og/v2?division=Scheduled+Message+APIs\u0026amp;title=Update+Scheduled+Message\u0026amp;description=Updates+a+pending+scheduled+message+%E2%80%94+content%2C+next+run+time%2C+repetition%2C+pause%2Fresume+or+skip-next.+Completed+messages+cannot+be+updated.\u0026amp;theme=c8ab22e6a9eb26c6f79b535c\u0026amp;signature=cde964cf3a8931748b2bf73fc8d400db9109f69adefbf5a89003152eba3ce83a\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update Scheduled Message - Periskope Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates a pending scheduled message — content, next run time, repetition, pause/resume or skip-next. Completed messages cannot be updated.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://bharatkumarramesh.mintlify.site/_mintlify/api/og/v2?division=Scheduled+Message+APIs\u0026amp;title=Update+Scheduled+Message\u0026amp;description=Updates+a+pending+scheduled+message+%E2%80%94+content%2C+next+run+time%2C+repetition%2C+pause%2Fresume+or+skip-next.+Completed+messages+cannot+be+updated.\u0026amp;theme=c8ab22e6a9eb26c6f79b535c\u0026amp;signature=cde964cf3a8931748b2bf73fc8d400db9109f69adefbf5a89003152eba3ce83a\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/bharatkumarramesh/xEFzGZM_csru_Nms/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Periskope Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#15803D\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.periskope.app/api-reference/scheduled-messages/update-scheduled-message\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/scheduled-messages/update-scheduled-message.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.periskope.app/#organization\",\"name\":\"Periskope Docs\",\"url\":\"https://docs.periskope.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/bharatkumarramesh/Sq5VlnE2OgDOCH8s/logo/periskope-logo-full.svg?fit=max\u0026auto=format\u0026n=Sq5VlnE2OgDOCH8s\u0026q=85\u0026s=cace2e822ea7c0cd2a98b9d946baa593\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.periskope.app#website\",\"name\":\"Periskope Docs\",\"url\":\"https://docs.periskope.app\",\"publisher\":{\"@id\":\"https://docs.periskope.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.periskope.app/api-reference/scheduled-messages/update-scheduled-message#webpage\",\"url\":\"https://docs.periskope.app/api-reference/scheduled-messages/update-scheduled-message\",\"name\":\"Update Scheduled Message\",\"description\":\"Updates a pending scheduled message — content, next run time, repetition, pause/resume or skip-next. Completed messages cannot be updated.\",\"dateModified\":\"2026-09-25T16:09:26.374Z\",\"isPartOf\":{\"@id\":\"https://docs.periskope.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.periskope.app/api-reference/scheduled-messages/update-scheduled-message#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.periskope.app/api-reference/scheduled-messages/update-scheduled-message#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Scheduled Message APIs\",\"item\":\"https://docs.periskope.app/api-reference/scheduled-messages/list-scheduled-messages\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update Scheduled Message\",\"item\":\"https://docs.periskope.app/api-reference/scheduled-messages/update-scheduled-message\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.periskope.app/api-reference/scheduled-messages/update-scheduled-message#apireference\",\"headline\":\"Update Scheduled Message\",\"name\":\"Update Scheduled Message\",\"description\":\"Updates a pending scheduled message — content, next run time, repetition, pause/resume or skip-next. Completed messages cannot be updated.\",\"url\":\"https://docs.periskope.app/api-reference/scheduled-messages/update-scheduled-message\",\"mainEntityOfPage\":{\"@id\":\"https://docs.periskope.app/api-reference/scheduled-messages/update-scheduled-message#webpage\"},\"dateModified\":\"2026-09-25T16:09:26.374Z\",\"publisher\":{\"@id\":\"https://docs.periskope.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.periskope.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Periskope Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Periskope Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/scheduled-messages/update-scheduled-message.md","siteName":"Periskope Docs","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/get-started/introduction"}]},{"anchor":"APIs \u0026 Webhooks","icon":"webhook","groups":[{"group":"API","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authorization","href":"/api-reference/authorization"},{"title":"SDK","href":"/api-reference/sdk"},{"group":"Objects","pages":[{"title":"The Chat Object","href":"/api-reference/objects/the-chat-object"},{"title":"The Chat Notification Object","href":"/api-reference/objects/the-chat-notification-object"},{"title":"The Call Object","href":"/api-reference/objects/the-call-object"},{"title":"The Reaction Object","href":"/api-reference/objects/the-reaction-object"},{"title":"The Message Object","href":"/api-reference/objects/the-message-object"},{"title":"The Contact Object","href":"/api-reference/objects/the-contact-object"},{"title":"The Ticket Info Object","href":"/api-reference/objects/the-ticket-info-object"},{"title":"The Task Object","href":"/api-reference/objects/the-task-object"},{"title":"The Phone Object","href":"/api-reference/objects/the-phone-object"},{"title":"The Note Object","href":"/api-reference/objects/the-note-object"}]},{"title":"WhatsApp Message Ack Status","href":"/api-reference/delivery-status"}]},{"group":"Chat APIs","icon":"comments","pages":[{"title":"Get Chat By ID","openapi":"api-reference/openapi-generated.json GET /v1/chats/{chat_id}","href":"/api-reference/chat/get-chat-by-id"},{"title":"Get Messages in a Chat","openapi":"api-reference/openapi-generated.json GET /v1/chats/{chat_id}/messages","href":"/api-reference/chat/get-messages-in-chat"},{"title":"Get Private Notes in a Chat","openapi":"api-reference/openapi-generated.json GET /v1/chats/{chat_id}/notes","href":"/api-reference/chat/get-private-notes-in-chat"},{"title":"Get Notifications in a Chat","openapi":"api-reference/openapi-generated.json GET /v1/chats/{chat_id}/notifications","href":"/api-reference/chat/get-notifications-in-chat"},{"title":"List All Chats","openapi":"api-reference/openapi-generated.json GET /v1/chats","href":"/api-reference/chat/list-all-chats"},{"title":"List All Messages","openapi":"api-reference/openapi-generated.json GET /v1/chats/messages","href":"/api-reference/chat/list-all-messages"},{"title":"List All Notifications","openapi":"api-reference/openapi-generated.json GET /v1/chats/notifications","href":"/api-reference/chat/list-all-notifications"},{"title":"Update Chat Labels","openapi":"api-reference/openapi-generated.json PATCH /v1/chats/labels","href":"/api-reference/chat/update-chat-labels"},{"title":"Update Chat","openapi":"api-reference/openapi-generated.json PATCH /v1/chats/{chat_id}","href":"/api-reference/chat/update-chat"},{"title":"Mark chat as read","openapi":"api-reference/openapi-generated.json POST /v1/chats/{chat_id}/read","href":"/api-reference/chat/mark-read"},{"title":"Update Chat Access","openapi":"api-reference/openapi-generated.json PATCH /v1/chats/access","href":"/api-reference/chat/override-chat-access"},{"title":"Get Chat Audit Logs","openapi":"api-reference/openapi-generated.json GET /v1/chats/{chat_id}/audit-logs","href":"/api-reference/chat/get-chat-audit-logs"},{"title":"Update Chat AI Settings","openapi":"api-reference/openapi-generated.json PATCH /v1/chats/{chat_id}/ai","href":"/api-reference/chat/update-chat-ai-settings"}]},{"group":"Group Settings APIs","pages":[{"title":"Create Group","openapi":"api-reference/openapi-generated.json POST /v1/chats/create","href":"/api-reference/chat/create-group"},{"title":"Generate a new invite link for a chat","openapi":"api-reference/openapi-generated.json POST /v1/chats/{chat_id}/invite","href":"/api-reference/chat/refresh-invite"},{"title":"Add Participant to Group","openapi":"api-reference/openapi-generated.json POST /v1/chats/{chat_id}/add","href":"/api-reference/chat/add-participant"},{"title":"Remove Participant from Group","openapi":"api-reference/openapi-generated.json POST /v1/chats/{chat_id}/remove","href":"/api-reference/chat/remove-participant"},{"title":"Promote Participant to Admin","openapi":"api-reference/openapi-generated.json POST /v1/chats/{chat_id}/promote","href":"/api-reference/chat/promote-participant-to-admin"},{"title":"Demote Participant to Member","openapi":"api-reference/openapi-generated.json POST /v1/chats/{chat_id}/demote","href":"/api-reference/chat/demote-participant-to-member"},{"title":"Update Group Settings","openapi":"api-reference/openapi-generated.json POST /v1/chats/{chat_id}/settings","href":"/api-reference/chat/update-group-settings"},{"title":"Accept Group Invite","openapi":"api-reference/openapi-generated.json POST /v1/chats/accept-invite","href":"/api-reference/chat/accept-group-invite"},{"title":"Leave Group","openapi":"api-reference/openapi-generated.json POST /v1/chats/{chat_id}/leave","href":"/api-reference/chat/leave-group"}]},{"group":"Message APIs","icon":"comment","pages":[{"title":"Send Message","openapi":"api-reference/openapi-generated.json POST /v1/message/send","href":"/api-reference/message/send-message"},{"title":"Send Sync Message","openapi":"api-reference/openapi-generated.json POST /v1/message/send-sync","href":"/api-reference/message/send-message-sync"},{"title":"Broadcast Message","openapi":"api-reference/openapi-generated.json POST /v1/message/broadcast","href":"/api-reference/message/broadcast-message"},{"title":"Delete a Broadcast","openapi":"api-reference/openapi-generated.json DELETE /v1/message/broadcast/{broadcast_id}","href":"/api-reference/message/delete-broadcast"},{"title":"Delete Message","openapi":"api-reference/openapi-generated.json POST /v1/message/{message_id}/delete","href":"/api-reference/message/delete-message"},{"title":"Edit Message","openapi":"api-reference/openapi-generated.json POST /v1/message/{message_id}/edit","href":"/api-reference/message/edit-message"},{"title":"Forward Message","openapi":"api-reference/openapi-generated.json POST /v1/message/{message_id}/forward","href":"/api-reference/message/forward-message"},{"title":"Get Message","openapi":"api-reference/openapi-generated.json GET /v1/message/{message_id}","href":"/api-reference/message/get-message"},{"title":"React to Message","openapi":"api-reference/openapi-generated.json POST /v1/message/{message_id}/react","href":"/api-reference/message/react-to-message"},{"title":"Pin Message","openapi":"api-reference/openapi-generated.json POST /v1/message/{message_id}/pin","href":"/api-reference/message/pin-message"},{"title":"Get Message Status","openapi":"api-reference/openapi-generated.json GET /v1/message/{unique_id}/status","href":"/api-reference/message/message-status"},{"title":"List All Message Queues","openapi":"api-reference/openapi-generated.json POST /v1/message/queues","href":"/api-reference/message/list-queue-jobs"},{"title":"Get Status of Message Queues","openapi":"api-reference/openapi-generated.json GET /v1/message/queues/health","href":"/api-reference/message/queue-health"},{"title":"Purge Message Queues","openapi":"api-reference/openapi-generated.json POST /v1/message/queues/purge","href":"/api-reference/message/purge-queue-jobs"}]},{"group":"Scheduled Message APIs","pages":[{"title":"List Scheduled Messages","openapi":"api-reference/openapi-generated.json GET /v1/message/scheduled","href":"/api-reference/scheduled-messages/list-scheduled-messages"},{"title":"Schedule a Message","openapi":"api-reference/openapi-generated.json POST /v1/message/scheduled","href":"/api-reference/scheduled-messages/schedule-message"},{"title":"Get Scheduled Message","openapi":"api-reference/openapi-generated.json GET /v1/message/scheduled/{scheduled_id}","description":"Retrieves a scheduled message by its scheduled_id.","href":"/api-reference/scheduled-messages/get-scheduled-message"},{"title":"Update Scheduled Message","openapi":"api-reference/openapi-generated.json PATCH /v1/message/scheduled/{scheduled_id}","href":"/api-reference/scheduled-messages/update-scheduled-message"},{"title":"Delete Scheduled Message","openapi":"api-reference/openapi-generated.json DELETE /v1/message/scheduled/{scheduled_id}","description":"Permanently deletes a scheduled message — no further runs happen. Its run history stays available via the occurrences endpoint.","href":"/api-reference/scheduled-messages/delete-scheduled-message"},{"title":"List Scheduled Message Runs","openapi":"api-reference/openapi-generated.json GET /v1/message/scheduled/{scheduled_id}/occurrences","href":"/api-reference/scheduled-messages/list-scheduled-message-occurrences"}]},{"group":"Call APIs","icon":"phone-volume","pages":[{"title":"List Calls","openapi":"api-reference/openapi-generated.json GET /v1/calls","href":"/api-reference/calls/list-calls"},{"title":"Get Call","openapi":"api-reference/openapi-generated.json GET /v1/calls/{call_id}","href":"/api-reference/calls/get-call"}]},{"group":"Media APIs","icon":"photo-film","pages":[{"title":"Migrate Media URL","api":"POST https://api.periskope.app/v1/media/migrate-url","href":"/api-reference/media/migrate-url"},{"title":"Migrate Media URLs (Batch)","api":"POST https://api.periskope.app/v1/media/migrate-url/batch","href":"/api-reference/media/migrate-url-batch"}]},{"group":"Contact APIs","icon":"phone","pages":[{"title":"Get Contact By ID","openapi":"api-reference/openapi-generated.json GET /v1/contacts/{contact_id}","href":"/api-reference/contacts/get-contact-by-id"},{"title":"Get Contacts","openapi":"api-reference/openapi-generated.json GET /v1/contacts","href":"/api-reference/contacts/get-contacts"},{"title":"Update Contact Labels","openapi":"api-reference/openapi-generated.json PATCH /v1/contacts/labels","href":"/api-reference/contacts/update-contact-labels"},{"title":"Update Contact","openapi":"api-reference/openapi-generated.json PATCH /v1/contacts/{contact_id}","href":"/api-reference/contacts/update-contact"},{"title":"Create Contact","openapi":"api-reference/openapi-generated.json POST /v1/contacts/create","href":"/api-reference/contacts/create-contact"},{"title":"Check Contact Exists","openapi":"api-reference/openapi-generated.json POST /v1/contacts/check","href":"/api-reference/contacts/check-contact"}]},{"group":"Ticket APIs","icon":"ticket","pages":[{"title":"Get Ticket By ID","openapi":"api-reference/openapi-generated.json GET /v1/tickets/{ticket_id}","href":"/api-reference/tickets/get-ticket-by-id"},{"title":"Get Tickets","openapi":"api-reference/openapi-generated.json GET /v1/tickets","href":"/api-reference/tickets/get-tickets"},{"title":"Update Ticket","openapi":"api-reference/openapi-generated.json PATCH /v1/tickets/{ticket_id}","href":"/api-reference/tickets/update-ticket"},{"title":"Create Ticket","openapi":"api-reference/openapi-generated.json POST /v1/tickets/create","href":"/api-reference/tickets/create-ticket"},{"title":"Get Ticket Audit Logs","openapi":"api-reference/openapi-generated.json GET /v1/tickets/{ticket_id}/audit-logs","href":"/api-reference/tickets/get-ticket-audit-logs"}]},{"group":"Custom Property APIs","icon":"list-dropdown","pages":[{"title":"Get All Custom Properties","openapi":"api-reference/openapi-generated.json GET /v1/properties","href":"/api-reference/properties/get-all-custom-properties"},{"title":"Get Custom Property","openapi":"api-reference/openapi-generated.json GET /v1/properties/{property_id}","href":"/api-reference/properties/get-custom-property"},{"title":"Create Custom Property","openapi":"api-reference/openapi-generated.json POST /v1/properties/create","href":"/api-reference/properties/create-custom-property"},{"title":"Update Custom Property","openapi":"api-reference/openapi-generated.json POST /v1/properties/{property_id}","href":"/api-reference/properties/update-custom-property"},{"title":"Update Property Options","openapi":"api-reference/openapi-generated.json POST /v1/properties/{property_id}/options","href":"/api-reference/properties/update-property-options"},{"title":"Delete Custom Properties","openapi":"api-reference/openapi-generated.json DELETE /v1/properties","href":"/api-reference/properties/delete-custom-property"}]},{"group":"Task APIs","icon":"list-check","pages":[{"title":"Get Task By ID","openapi":"api-reference/openapi-generated.json GET /v1/tasks/{task_id}","href":"/api-reference/tasks/get-task-by-id"},{"title":"Get All Tasks","openapi":"api-reference/openapi-generated.json GET /v1/tasks","href":"/api-reference/tasks/get-tasks"},{"title":"Create Task","openapi":"api-reference/openapi-generated.json POST /v1/tasks/create","href":"/api-reference/tasks/create-task"},{"title":"Update Task","openapi":"api-reference/openapi-generated.json PATCH /v1/tasks/{task_id}","href":"/api-reference/tasks/update-task"}]},{"group":"Queue APIs","icon":"list","pages":[{"title":"Fetch Queue Jobs","openapi":"api-reference/openapi-generated.json GET /v1/queue/jobs","href":"/api-reference/queues/fetch-queue-jobs"},{"title":"Get Broadcast Status","openapi":"api-reference/openapi-generated.json GET /v1/queue/broadcast","href":"/api-reference/queues/get-broadcast-status"},{"title":"Get Queue Status","openapi":"api-reference/openapi-generated.json GET /v1/queue","href":"/api-reference/queues/get-queue-status"},{"title":"Purge Queue","openapi":"api-reference/openapi-generated.json DELETE /v1/queue/purge","href":"/api-reference/queues/purge-queue"}]},{"group":"Phone APIs","icon":"phone","pages":[{"title":"Get phone","openapi":"api-reference/openapi-generated.json GET /v1/phones","href":"/api-reference/phones/get-phone"},{"title":"Get All Phones","openapi":"api-reference/openapi-generated.json GET /v1/phones/all","href":"/api-reference/phones/get-all-phones"},{"title":"Get QR","openapi":"api-reference/openapi-generated.json GET /v1/phones/qr","href":"/api-reference/phones/get-qr"},{"title":"Reset Phone","openapi":"api-reference/openapi-generated.json POST /v1/phones/reset","href":"/api-reference/phones/reset-phone"},{"title":"Restart Phone","openapi":"api-reference/openapi-generated.json POST /v1/phones/restart","href":"/api-reference/phones/restart-phone"},{"title":"Resync Phone","openapi":"api-reference/openapi-generated.json POST /v1/phones/resync","href":"/api-reference/phones/resync-phone"},{"title":"Update phone","openapi":"api-reference/openapi-generated.json PATCH /v1/phones/update","href":"/api-reference/phones/update-phone"},{"title":"Create Phone","openapi":"api-reference/openapi-generated.json POST /v1/phones/create","href":"/api-reference/phones/create-phone"},{"title":"Delete Phone","openapi":"api-reference/openapi-generated.json DELETE /v1/phones/delete","href":"/api-reference/phones/delete-phone"}]},{"group":"Notes APIs","icon":"comment","pages":[{"title":"Send Private Notes","openapi":"api-reference/openapi-generated.json POST /v1/notes/create","href":"/api-reference/notes/create-private-notes"},{"title":"Get Private Note","openapi":"api-reference/openapi-generated.json GET /v1/notes/{note_id}","href":"/api-reference/notes/get-private-note"},{"title":"List All Private Notes","openapi":"api-reference/openapi-generated.json GET /v1/notes","href":"/api-reference/notes/list-all-private-notes"}]},{"group":"Reaction APIs","icon":"comment","pages":[{"title":"Get Reactions","openapi":"api-reference/openapi-generated.json GET /v1/reactions","href":"/api-reference/reactions/get-reactions"}]},{"group":"Knowledge Base APIs","icon":"brain","pages":[{"title":"Get All Knowledge Base Items","openapi":"api-reference/openapi-generated.json GET /v1/knowledge-base","href":"/api-reference/knowledge-base/get-all-knowledge-base"},{"title":"Get FAQ by ID","openapi":"api-reference/openapi-generated.json GET /v1/knowledge-base/faq/{context_id}","href":"/api-reference/knowledge-base/get-faq-by-id"},{"title":"Create FAQ","openapi":"api-reference/openapi-generated.json POST /v1/knowledge-base/faq/create","href":"/api-reference/knowledge-base/create-faq"},{"title":"Update FAQ","openapi":"api-reference/openapi-generated.json PATCH /v1/knowledge-base/faq/{context_id}","href":"/api-reference/knowledge-base/update-faq"},{"title":"Delete FAQ","openapi":"api-reference/openapi-generated.json DELETE /v1/knowledge-base/faq/{context_id}","href":"/api-reference/knowledge-base/delete-faq"},{"title":"Get Document by ID","openapi":"api-reference/openapi-generated.json GET /v1/knowledge-base/document/{document_id}","href":"/api-reference/knowledge-base/get-document-by-id"},{"title":"Create Document","openapi":"api-reference/openapi-generated.json POST /v1/knowledge-base/document/create","href":"/api-reference/knowledge-base/create-document"},{"title":"Delete Document","openapi":"api-reference/openapi-generated.json DELETE /v1/knowledge-base/document/{document_id}","href":"/api-reference/knowledge-base/delete-document"}]},{"group":"Member APIs","icon":"user-group","pages":[{"title":"Invite Members","openapi":"api-reference/openapi-generated.json POST /v1/members/invite","href":"/api-reference/members/invite-members"},{"title":"Update Member Access","openapi":"api-reference/openapi-generated.json PATCH /v1/members/access","href":"/api-reference/members/update-member-access"},{"title":"Delete Member","openapi":"api-reference/openapi-generated.json DELETE /v1/members/{email_id}","href":"/api-reference/members/delete-member"}]},{"group":"AI APIs","icon":"robot","pages":[{"title":"Trigger AI Reply","openapi":"api-reference/openapi-generated.json POST /v1/ai/reply","href":"/api-reference/ai/trigger-ai-reply"}]},{"group":"Webhook APIs","icon":"webhook","pages":[{"title":"List Webhooks","openapi":"api-reference/openapi-generated.json GET /v1/webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Create Webhook","openapi":"api-reference/openapi-generated.json POST /v1/webhooks","href":"/api-reference/webhooks/create-webhook"},{"title":"Get Webhook by ID","openapi":"api-reference/openapi-generated.json GET /v1/webhooks/{id}","href":"/api-reference/webhooks/get-webhook-by-id"},{"title":"Update Webhook","openapi":"api-reference/openapi-generated.json PATCH /v1/webhooks/{id}","href":"/api-reference/webhooks/update-webhook"},{"title":"Delete Webhook","openapi":"api-reference/openapi-generated.json DELETE /v1/webhooks/{id}","href":"/api-reference/webhooks/delete-webhook"}]},{"group":"Webhooks","pages":[{"title":"Introduction","href":"/api-reference/webhooks/introduction"},{"title":"chat.created","icon":"comments","href":"/api-reference/webhooks/chat.created"},{"title":"chat.notification.created","icon":"comments","href":"/api-reference/webhooks/chat.notification.created"},{"title":"chat.custom-properties.updated","icon":"comments","href":"/api-reference/webhooks/chat.custom-properties.updated"},{"title":"message.created","icon":"comment","href":"/api-reference/webhooks/message.created"},{"title":"message.updated","icon":"comment","href":"/api-reference/webhooks/message.updated"},{"title":"message.deleted","icon":"comment","href":"/api-reference/webhooks/message.deleted"},{"title":"message.ack.updated","icon":"comment","href":"/api-reference/webhooks/message.ack.updated"},{"title":"message.ticket.attached","icon":"comment","href":"/api-reference/webhooks/message.ticket.attached"},{"title":"message.flagged","icon":"comment","href":"/api-reference/webhooks/message.flagged"},{"title":"message.unflagged","icon":"comment","href":"/api-reference/webhooks/message.unflagged"},{"title":"note.created","icon":"comment","href":"/api-reference/webhooks/note.created"},{"title":"reaction.created","icon":"face-smile","href":"/api-reference/webhooks/reaction.created"},{"title":"reaction.updated","icon":"face-smile","href":"/api-reference/webhooks/reaction.updated"},{"title":"ticket.created","icon":"tag","href":"/api-reference/webhooks/ticket.created"},{"title":"ticket.updated","icon":"tag","href":"/api-reference/webhooks/ticket.updated"},{"title":"ticket.deleted","icon":"tag","href":"/api-reference/webhooks/ticket.deleted"},{"title":"org.phone.updated","icon":"phone","href":"/api-reference/webhooks/org.phone.updated"},{"title":"org.phone.connected","icon":"phone","href":"/api-reference/webhooks/org.phone.connected"},{"title":"org.phone.disconnected","icon":"phone","href":"/api-reference/webhooks/org.phone.disconnected"},{"title":"org.phone.qr","icon":"phone","href":"/api-reference/webhooks/org.phone.qr"}]}]},{"anchor":"Free Tools","icon":"toolbox","href":"https://tools.periskope.app"}]},"basePath":"","title":"Update Scheduled Message - Periskope Docs","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B6WFFOBL.js","utils-BN5um1KA.js","cloneDeep-C3md22mN.js","_Uint8Array-DLlL8L26.js","isObject-FP1Yky1u.js","utils-BSmbkXJR.js","addUniqueKeysToSchema-2tqcVnUE.js","snippetPresets-CtWfvr2J.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DkKHBy30.js","isEqual-O3q7y6pq.js","usePlaygroundInputsStore-Brc5H9UJ.js","shallow-C4L4xvbs.js","getApiPlaygroundDisplay-2bxyq_aI.js","CodeSnippet-BJu8ddd5.js","CodeSnippets-dazWmoqB.js","Page-CnLhKuUV.js","getPastedJson-Chy3Qa1S.js","icon-CyO7h3jh.js","MethodPill-Dle0_91v.js","DuplicateIcon-CVvWAf4a.js","createIcon-Di07A27B.js","DynamicMarkdown-C4w9kavL.js","SectionHeading-XiBebVYC.js","axios-vUo_bRtp.js","Markdown-DTeL0SpS.js","dist-OCScizqf.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-KcneGfMY.js"]}