List leases eligible for a notice campaign
Returns the ids of the active leases that would receive an insurance-required notice today: no coverage of any kind, not opted out, not already in a grace period, and not already on a waiver. Leases that started before the company enrolled are included here, which is what makes a manual campaign worth running.
Authorization
AuthorizationstringrequiredBearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.
Response
200 · The eligible lease ids. Both fields come back empty when the company does not run the damage waiver program.
leaseIdsstring[]The leases that would receive a notice. Pass these to Send a notice campaign.
totalCountintegerHow many lease ids are in the list.