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.

Changes

Changed in 3 of the 11 revisions of this API.2115

    • removed the required property _meta/credits/accountPlan from the response with the 200 status

      response-required-property-removed

    • added the new pacing enum value to the error/quotaKind response property for the response status 400

      response-property-enum-value-added

    • added the new pacing enum value to the error/quotaKind response property for the response status 401

      response-property-enum-value-added

    • added the new pacing enum value to the error/quotaKind response property for the response status 403

      response-property-enum-value-added

    • added the new pacing enum value to the error/quotaKind response property for the response status 404

      response-property-enum-value-added

    • added the new pacing enum value to the error/quotaKind response property for the response status 409

      response-property-enum-value-added

    • added the new pacing enum value to the error/quotaKind response property for the response status 410

      response-property-enum-value-added

    • added the new pacing enum value to the error/quotaKind response property for the response status 422

      response-property-enum-value-added

    • added the new pacing enum value to the error/quotaKind response property for the response status 429

      response-property-enum-value-added

    • added the new pacing enum value to the error/quotaKind response property for the response status 500

      response-property-enum-value-added

    • added the new pacing enum value to the error/quotaKind response property for the response status 502

      response-property-enum-value-added

    • added the new pacing enum value to the error/quotaKind response property for the response status 503

      response-property-enum-value-added

  • 1ad91026000b15See the full diff
    • removed the required property staggerMinutes from the response with the 200 status

      response-required-property-removed

    • added the optional property _meta to the response with the 200 status

      response-optional-property-added

    • added the optional property retriesPending to the response with the 200 status

      response-optional-property-added

    • added the optional property scheduleShifted to the response with the 200 status

      response-optional-property-added

    • added the optional property staggerMinutesMax to the response with the 200 status

      response-optional-property-added

    • added the optional property staggerMinutesMin to the response with the 200 status

      response-optional-property-added

Of the 11 revisions, 1 has no diff computed.