Configure review prompt

PUT

https://api.sureshake.com/v2/execution/cycles/{cycleId}/review-prompt

Path parameters

cycleId
string
required
format: uuid

Request body JSON required

enabled
boolean
required
cadence
weekly
or
biweekly
or
monthly
required
dayOfWeek
integer
required
maximum: 6 · minimum: 0
localTime
string
required
pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]$
timeZone
string
required
maxLength: 100 · minLength: 1

Returns

200

Default Response

JSON

data
object
required
- cycleId
  string
  required
  format: uuid
- status
  disabled
  or
  inactive
  or
  upcoming
  or
  due
  required
- schedule
  object
  required
  enabled
  boolean
  required
  cadence
  weekly
  or
  biweekly
  or
  monthly
  required
  dayOfWeek
  integer
  required
  maximum: 6 · minimum: 0
  localTime
  string
  required
  pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]$
  timeZone
  string
  required
  maxLength: 100 · minLength: 1
  configuredBy
  string
  or null
  required
  minLength: 1
  configuredAt
  string
  or null
  required
  format: date-time
- scheduledAt
  string
  or null
  required
  format: date-time
- nextScheduledAt
  string
  or null
  required
  format: date-time
- periodStart
  string
  or null
  required
  format: date-time
- periodEndExclusive
  string
  or null
  required
  format: date-time
- title
  string
  required
  minLength: 1
- message
  string
  required
  minLength: 1
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

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
}

404

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
}

409

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
}

422

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
}

429

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
}

502

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
}

503

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
}