Skip to main content
PUT
/
meters
/
{meterId}
Update Meter
curl --request PUT \
  --url https://connect.withvayu.com/meters/{meterId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "eventName": "<string>"
}
'
import requests

url = "https://connect.withvayu.com/meters/{meterId}"

payload = {
"name": "<string>",
"eventName": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', eventName: '<string>'})
};

fetch('https://connect.withvayu.com/meters/{meterId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://connect.withvayu.com/meters/{meterId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'eventName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://connect.withvayu.com/meters/{meterId}"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"eventName\": \"<string>\"\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://connect.withvayu.com/meters/{meterId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"eventName\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://connect.withvayu.com/meters/{meterId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"eventName\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "meter": {
    "name": "<string>",
    "eventName": "<string>",
    "aggregationMethod": {
      "field": "<string>",
      "instanceKey": "<string>"
    },
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "filter": {
      "conditions": [
        {
          "criterions": [
            {
              "field": "<string>",
              "value": "<string>"
            }
          ]
        }
      ]
    }
  }
}
{
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"params": [
{
"param": "<string>",
"message": "<string>"
}
]
}
{
"type": "authentication_error",
"code": "authentication_failed",
"message": "<string>"
}
{
"type": "invalid_request_error",
"code": "resource_not_found",
"message": "<string>"
}
{
"type": "rate_limit_error",
"code": "rate_limit_exceeded",
"message": "<string>"
}
{
"type": "api_error",
"code": "internal_error",
"message": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

meterId
string
required
Pattern: ^[0-9a-fA-F]{24}$

Body

application/json
name
string

The name of the meter

Minimum string length: 1
eventName
string

The name of the event that the meter is tracking.

Minimum string length: 1
aggregationMethod
object

The aggregation method defines how the events should be summed to represent a usage value.

filter
object

The filter to apply to the events to be included in the meter. The filter object contains an array of Conditions, each condition represents a logical OR statement. Each condition contains an array of Criteria (criterions), each criterion represents a logical AND statement.

Response

RequestSuccess

meter
object
required