API ReferenceapiaffiliatesPOST /v1/admin/affiliates/retire-eligible

POST /v1/admin/affiliates/retire-eligible

Service: affiliates · operationId: (none)

Scan for affiliates meeting retirement criteria and transition them to retired

Required scopes

(no scope declared — review service config)

Responses

200 Retirement scan completed

{
  "type": "object",
  "properties": {
    "scanned": {
      "type": "integer"
    },
    "retired": {
      "type": "integer"
    }
  },
  "required": [
    "scanned",
    "retired"
  ]
}

500 Internal error

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

Example

curl -X POST https://affiliates.platform.loop.health/v1/admin/affiliates/retire-eligible \
  -H "Authorization: Bearer $ACCESS_TOKEN"