Send a notice campaign
Sends the insurance-required notice to the leases you name, which starts each one's grace period. The call always succeeds as a whole and reports per-lease outcomes, so a lease with no reachable tenant email does not stop the rest. Requires the leasing_insurance:write permission.
Authorization
AuthorizationstringrequiredBearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.
Body
application/json
leaseIdsstring[]requiredThe leases to notify. At least one. Any id that is not one of this company's leases is reported back as a failure rather than rejecting the whole call.
Response
200 · What happened for each lease.
totalCountintegerHow many lease ids were sent in the request.
successCountintegerHow many notices went out.
failedCountintegerHow many leases could not be notified.
failuresobject[]One entry per lease that could not be notified. Empty when everything went out.