Create meters

URL Expired

The URL for this request expired after 30 days.

Required Fields

Only globally required fields are indicated as required in this endpoint. If you know the program you are intending to enroll these meters into, additional program-specific required fields need to be included. Refer to the following knowledge center articles for these fields:

• California DSGS fields (Option 3 & Option 4)
• New England fields (Clean Peak Standard & Connected Solutions)
• Texas ERS fields
• New York SCR fields
  Most partners will use Leap Connect to have customer-authorized meters created but in select cases, partners can directly create meters through this endpoint

Parameters

update_existing

• Type: boolean
• Defaults to false
  If set to true, the API will update existing meters with the same partner reference. If set to false or parameter is omitted, the API will create new meters and return a duplicate error for existing meters with the same partner reference.

file_name

• Type: string
• Length ≤ 255
  If set, the API will use this file_name when uploading the file to the API. If not set, the API will use the job_id and file_extension to create a file_name as fallback. The file_name must be a valid string up to 255 characters matching the file naming pattern.

Responses

• 201: The job ID that got created, which you can use to poll the status of the job.

• 400: Failed to create meter batch job, because the meter batch job request sent was invalid

• 403: You do not have the necessary permissions for this operation.

• 500: Internal server error

Example Request

curl --request POST \
     --url 'https://api.staging.leap.energy/v1.1/jobs/meters?update_existing=false' \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Example Response

{
  "job_id": "5961a37f-6325-431c-97cb-82f35e3c09cf"
}