Sign in
OpenAPI 3.0.3AGPL-3.0 license2026-08-2011401.8 MB

a1e86af2406d

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

Messages scheduled.

triggerFailuresinteger required

Messages that failed to schedule and were reverted to draft.

retriesPendinginteger

Messages whose first trigger failed and are on a delayed retry. Still in flight, not lost.

scheduledSendAtstring required

ISO datetime for the first send.

scheduleShiftedboolean

True when the server moved the requested send time, so a caller does not report a time that will not happen.

staggerMinutesMininteger

Shortest gap between two staggered sends. 0 for a single message.

staggerMinutesMaxinteger

Longest gap between two staggered sends. The real gap is jittered between the two.

lastSendAtstring required

ISO datetime the last staggered message is due.

creditsUsedinteger required

Credits consumed by this call. 0 for free endpoints, cached results, duplicates, and for every query that does not touch LinkedIn.

retryAfterinteger required

Seconds to wait before another call of the same type. 0 means no wait is needed.