REST /api/v1/pause-notifications 4 endpoints
POST /api/v1/pause-notifications/api/v1/pause-notifications/pause-activated

Send notification when a mentor pause is activated

Public

Request Example

{
  "mentor_id": "mentor-042",
  "expected_return_date": "2026-05-01T00:00:00Z",
  "pause_reason": "personal_leave"
}

Response Example

{
  "mentor_id": "mentor-042",
  "notifications_dispatched": [
    {
      "recipient": "mentor-042",
      "channel": "email",
      "status": "sent",
      "message_id": "msg-00940"
    },
    {
      "recipient": "coordinator-007",
      "channel": "email",
      "status": "sent",
      "message_id": "msg-00941"
    }
  ],
  "dispatched_at": "2026-03-26T08:30:00Z"
}
POST /api/v1/pause-notifications/api/v1/pause-notifications/pause-lifted

Send notification when a mentor's pause is lifted

Public

Request Example

{
  "mentor_id": "mentor-042"
}

Response Example

{
  "mentor_id": "mentor-042",
  "notifications_dispatched": [
    {
      "recipient": "mentor-042",
      "channel": "email",
      "status": "sent",
      "message_id": "msg-00955"
    },
    {
      "recipient": "coordinator-007",
      "channel": "email",
      "status": "sent",
      "message_id": "msg-00956"
    }
  ],
  "dispatched_at": "2026-04-15T09:00:00Z"
}
POST /api/v1/pause-notifications/api/v1/pause-notifications/cert-expiry

Send notification that a mentor's certification has expired

Public

Request Example

{
  "mentor_id": "mentor-042",
  "expiry_date": "2026-03-31T00:00:00Z"
}

Response Example

{
  "mentor_id": "mentor-042",
  "notifications_dispatched": [
    {
      "recipient": "mentor-042",
      "channel": "email",
      "status": "sent",
      "message_id": "msg-00970"
    },
    {
      "recipient": "coordinator-007",
      "channel": "email",
      "status": "sent",
      "message_id": "msg-00971"
    }
  ],
  "dispatched_at": "2026-03-31T00:05:00Z"
}
POST /api/v1/pause-notifications/api/v1/pause-notifications/cert-expiry-reminder

Send advance warning that a mentor's certification will expire soon

Public

Request Example

{
  "mentor_id": "mentor-042",
  "days_remaining": 14
}

Response Example

{
  "mentor_id": "mentor-042",
  "days_remaining": 14,
  "notifications_dispatched": [
    {
      "recipient": "mentor-042",
      "channel": "email",
      "status": "sent",
      "message_id": "msg-00988"
    }
  ],
  "dispatched_at": "2026-03-17T08:00:00Z"
}

Additional Metadata

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}