Docs
API reference

Update the interview reminder settings

PATCH
/api/v1/organization/interview-reminders

Turns the nudge and the last call on or off, moves when they are due and sets the time zone of the send window; only the fields you send change. A candidate gets at most two reminders per invitation, each with a link to stop them, and none once the interview started, was cancelled or expired, the job is closed, or the candidate is marked not progressing or hired. Invitations sent before reminders began get none. To nudge a candidate right now, resend the interview (POST /v1/interviews/{id}/resend): it counts as the nudge. Needs organization:write, and the key's owner must still be an admin (permission_denied otherwise). Returns the settings after the change.

Required scope: organization:write.

Errors

  • 400: invalid_content_type, invalid_json, request_body_too_large, unknown_field
  • 401: authentication_required, invalid_api_key
  • 403: api_access_disabled, insufficient_scope, permission_denied
  • 422: invalid_parameter
  • 429: rate_limit_exceeded
  • 500: api_error
  • 503: maintenance_mode, service_unavailable

Authorization

ApiKey
headerAuthorizationBearer <probb_live_<id>_<secret>>

Request Body

application/json
  1. body
nudge?
lastCall?
timeZone?string

Response Body

Success.

application/json
  1. response
object*string
nudge*

The first reminder, a few days after the invitation.

lastCall*

The second reminder, shortly before the link expires.

timeZone*string

The IANA time zone (for example Europe/London) the 09:00 to 18:00 send window is read in. UTC until an admin sets it.

Example Request
# Set PROBB_URL and PROBB_API_KEY. Replace any *_VALUE placeholder and any example ID (such as job_example) with a real one.curl --fail-with-body -X PATCH "$PROBB_URL/api/v1/organization/interview-reminders" \  -H "Authorization: Bearer $PROBB_API_KEY" \  -H 'Content-Type: application/json' \  --data-binary '{  "nudge": {    "enabled": true,    "afterDays": 3  },  "lastCall": {    "enabled": true,    "hoursBefore": 24  },  "timeZone": "Europe/London"}'
Example Response
{  "object": "interview_reminder_settings",  "nudge": {    "enabled": true,    "afterDays": 1  },  "lastCall": {    "enabled": true,    "hoursBefore": 12  },  "timeZone": "string"}