Sign in

v1

latestOpenAPI 3.0.22026-07-141713124.8 KB
Incentives

Submit feedback on an incentive record

Customers and partners report data quality issues — wrong amount, expired program, missing program, etc. Feedback is queued internally for review.

At least one of canonical_id, ongoing_id, or user_message must be provided so we can act on the report.

post/incentives/feedback

Request body

canonical_idinteger

ID of an upfront program from the /incentives response (preferred when reporting on a specific record)

ongoing_idinteger

ID of an ongoing program from the /incentives response

feedback_type'wrong_amount' | 'expired' | 'missing' | 'wrong_tech' | 'wrong_provider' | 'other' required
  • wrong_amount: amount shown is incorrect
  • expired: program is no longer available
  • missing: there's an incentive we're not surfacing
  • wrong_tech: program is listed under wrong product category
  • wrong_provider: provider name or link is wrong
  • other: free-form (must include user_message)
user_messagestring

Free-form description (required when feedback_type is other or when no record id is provided)

zipcodestring
utility_eidinteger
statestring
tech_keystring

e.g. "heat_pump", "solar"

displayed_amountstring

What the customer saw in our response, e.g. "$1,000"

displayed_programstring
suggested_amountstring

What the customer thinks is correct

suggested_urlstring uri

Authority page URL with the correct data

Response

Feedback recorded

statusstring
feedback_idstring
messagestring

Example response

{
  "status": "ok",
  "message": "Thank you for reporting this. We will review and update the data."
}