Run approaching reviews

POST

https://api.sureshake.com/v2/execution/review-prompts/approaching-notifications/run

Request body JSON

horizonHours
optional
integer
maximum: 72 · minimum: 1 · default: 24

Returns

200

Default Response

JSON

outcome
object
required
- status
  completed
  or
  partial
  or
  failed
  required
- counts
  object
  required
  attempted
  integer
  required
  minimum: 0
  succeeded
  integer
  required
  minimum: 0
  failed
  integer
  required
  minimum: 0
  skipped
  integer
  required
  minimum: 0
- fatalError
  string
  or null
  required
  minLength: 1
}
fatalFailure
object
or null
required
- code
  REVIEW_SCHEDULE_SOURCE_UNAVAILABLE
  or
  REVIEW_SCHEDULE_INVALID
  or
  REVIEW_STATE_UNAVAILABLE
  or
  FOUNDER_RECIPIENTS_UNAVAILABLE
  or
  NOTIFICATION_ENQUEUE_UNAVAILABLE
  or
  NOTIFICATION_PROCESSING_FAILED
  required
- message
  string
  required
  minLength: 1
- retryable
  boolean
  required
}
results
array of
object
required
- cycleId
  string
  required
  format: uuid
- status
  notified
  or
  already_notified
  or
  not_due
  or
  filed
  or
  failed
  required
- scheduledAt
  string
  or null
  required
  format: date-time
- failure
  object
  or null
  required
  code
  REVIEW_SCHEDULE_SOURCE_UNAVAILABLE
  or
  REVIEW_SCHEDULE_INVALID
  or
  REVIEW_STATE_UNAVAILABLE
  or
  FOUNDER_RECIPIENTS_UNAVAILABLE
  or
  NOTIFICATION_ENQUEUE_UNAVAILABLE
  or
  NOTIFICATION_PROCESSING_FAILED
  required
  message
  string
  required
  minLength: 1
  retryable
  boolean
  required
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

{ "outcome": { "status": "completed", "counts": { "attempted": 0, "succeeded": 0, "failed": 0, "skipped": 0 }, "fatalError": "string" }, "fatalFailure": { "code": "REVIEW_SCHEDULE_SOURCE_UNAVAILABLE", "message": "string", "retryable": true }, "results": [ { "cycleId": "811bdbf8-a42f-4f8c-b62e-39c77332ffe1", "status": "notified", "scheduledAt": "2019-08-24T14:15:22Z", "failure": { "code": "REVIEW_SCHEDULE_SOURCE_UNAVAILABLE", "message": "string", "retryable": true } } ] }