API ReferenceapicommsPOST /v1/admin/dunning/send-reminders

POST /v1/admin/dunning/send-reminders

Service: comms · operationId: (none)

Required scopes

(no scope declared — review service config)

Responses

200 Dunning reminder dispatch summary

{
  "type": "object",
  "properties": {
    "sent": {
      "type": "integer"
    },
    "skipped": {
      "type": "integer"
    }
  },
  "required": [
    "sent",
    "skipped"
  ]
}

500 Failed to send dunning reminders

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

Example

curl -X POST https://comms.platform.loop.health/v1/admin/dunning/send-reminders \
  -H "Authorization: Bearer $ACCESS_TOKEN"