API Reference
Log In
API Reference

Update Team PR Health Digest Settings

Every field is optional and absent or null leaves it unchanged; a list replaces the stored one and an empty list clears it. slackConfigurationIds must be this team's Slack connections, at most 5; emailAddresses at most 20, each a valid address (it need not belong to a Revenium user); dayOfWeek MONDAY to SUNDAY; hourOfDay 0 to 23; timezone an IANA zone. When either switch ends on, at least one Slack channel or address and a timezone are required. Anything else is a 400. Changing a switch, the day, the hour or the zone recomputes nextSendAt and nextAlertAt. Turning the alert on starts it from now, so pull requests already rotting are never announced; lowering the rotting threshold does not announce old ones either. A pull request dismissed or snoozed when the alert goes out is not announced, and neither is one whose snooze covered the moment it crossed, even after that snooze ends; a snooze placed after the crossing silences it only while it lasts. The weekly digest still lists it once it is back in the queue.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the team that owns this data.

Body Params

A team's PR Health weekly digest and rotting alert settings

boolean | null

The weekly digest is on

boolean | null

Also post each weekday, at the digest hour, the pull requests that started rotting since the last alert. Turning it on starts from now: pull requests already rotting are never announced.

slackConfigurationIds
array of strings | null

The team's Slack channel connections to post to (hashids), at most 5. A connection of another team is a 400.

slackConfigurationIds
emailAddresses
array of strings | null

Addresses to email, at most 20, trimmed and deduplicated ignoring case. Any valid address; the recipient need not be a Revenium user.

emailAddresses
string | null

Digest day, MONDAY to SUNDAY

int32 | null

Local hour, 0 to 23, for the digest and for the weekday rotting alert

string | null

IANA time zone the day and hour are in. Null until saved, so a client can offer the viewer's own zone. Required when either switch is on.

date-time | null
date-time | null
string | null
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*