Skip to main content
PATCH
cURL

Authorizations

x-api-key
string
header
required

Your Leap API key. Send it in the x-api-key header: x-api-key: leap_live_....

Path Parameters

application_id
integer
required

Application ID to update. The application must belong to your organization.

Query Parameters

dryRun
boolean
default:false

If true, validates the request without applying changes

Example:

false

Body

application/json

Application update request. See schema for details.

Request body for updating an application by application ID (organization authentication). Matches GET /applications/{id} response structure without protected fields. All fields are optional - only include fields you want to modify.

Protected fields (cannot be updated): id, customer_id, organization_id, program_id, status, created_at, updated_at

rebate_type
string | null

Type of rebate being requested

payee_type
enum<string> | null

Who will receive the rebate payment

Available options:
customer,
contractor,
instant
submission_date
string<date> | null

Date the application was submitted

Example:

"2025-01-20"

approval_date
string<date> | null

Date the application was approved

Example:

"2025-01-25"

total_requested_amount
number<decimal> | null

Total rebate amount being requested. Equal to the sum of upfront_amount + install_amount + ongoing_amount.

upfront_amount
number<decimal> | null

Pre-install upfront incentive amount. Reserved for future use; currently always 0. Part of the itemized breakdown that sums to total_requested_amount.

install_amount
number<decimal> | null

At-install one-time incentive amount. Part of the itemized breakdown that sums to total_requested_amount.

ongoing_amount
number<decimal> | null

Ongoing incentive amount, per year. Part of the itemized breakdown that sums to total_requested_amount.

equipment_complete
boolean | null

Whether equipment documentation is complete

permit_complete
boolean | null

Whether permit documentation is complete

utility_complete
boolean | null

Whether utility documentation is complete

customer_device_id
integer[] | null

Array of customer device IDs associated with this application

customer
object

Customer fields to update (optional)

customer_devices
object[]

Array of customer devices to update. Each device must include 'id' to identify the device.

Response

Successfully updated application(s)

ok
boolean
Example:

true

requestId
string
Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

application_id
integer
Example:

123

customer_id
integer
Example:

456

mutations
object

Details about what was updated

data
object

Complete snapshot matching GET /applications/{id} response structure