v2

latestOpenAPI 3.0.3AGPL-3.0 license2026-07-2613501.9 MB
scheduledMessages

Batch-schedule drafts for auto-send

Schedule existing draft messages for auto-send at a specific time..

post/scheduled-messages/schedule

Request body

contactIdsstring[]

Schedule all drafts for these contacts

messageIdsstring[]

Schedule specific messages

scheduledSendAtstring required

ISO datetime for sending

editedMessagesobject

Map of messageId → new content for last-minute edits before scheduling

Response

Messages scheduled

successtrue required
scheduledinteger required

Number of messages scheduled

triggerFailuresinteger required

Number of messages that failed to schedule and were reverted to draft status

scheduledSendAtstring required

ISO datetime for first send

staggerMinutesinteger required

Minutes between staggered sends (0 if single message)

lastSendAtstring required

ISO datetime when last staggered message will be sent

creditsUsedinteger required

Credits consumed (always 0 for workspace operations).

retryAfterinteger required

Seconds to wait (always 0 for workspace operations).