Update a meter | Solvimon

curl -X PATCH https://test.api.solvimon.com/v1/meters/ \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "reference": "meter_registered_employee",
  "name": "registered_employees",
  "description": "The amount of employees registered with a customer.",
  "meter_values": [
    {
      "id": "metv_owDe9k0tsIY5LkBAel1P",
      "reference": "Employee count",
      "required": true
    }
  ],
  "meter_properties": [
    {
      "id": "metp_owDe9k0tsIY5LkBAel1X",
      "reference": "Employee type",
      "required": true
    },
    {
      "id": "metp_ZwDeeN0tfpdlb9AaeN1R",
      "reference": "Employee name",
      "required": false
    }
  ]
}'

{
  "reference": "meter_registered_employee",
  "object_type": "meter",
  "id": "met_9f8d7c6b2a1e4d3f9b0c",
  "name": "registered_employees",
  "description": "The amount of employees registered with a customer.",
  "status": "DRAFT",
  "meter_values": [
    {
      "id": "metv_owDe9k0tsIY5LkBAel1P",
      "object": {
        "reference": "Employee count",
        "object_type": "meter_value",
        "id": "metv_owDe9k0tsIY5LkBAel1P",
        "name": "Employee count",
        "description": "Total number of employees registered",
        "status": "DRAFT",
        "type": "NUMBER"
      },
      "required": true
    }
  ],
  "meter_properties": [
    {
      "id": "metp_owDe9k0tsIY5LkBAel1X",
      "object": {
        "reference": "Employee type",
        "status": "DRAFT",
        "object_type": "meter_property",
        "id": "metp_owDe9k0tsIY5LkBAel1X",
        "name": "Employee type",
        "description": "Type of employee (e.g., full-time, part-time, contractor)",
        "type": "ENUM",
        "enum_values": [
          "full-time",
          "part-time",
          "contractor",
          "intern"
        ]
      },
      "required": true
    }
  ]
}

Requires the METER.UPDATE permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

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

Path parameters

versionstringRequiredDefaults to 1

version

resourceIdOrReferencestringRequiredDefaults to

The ID or reference of the resource.

Request

This endpoint expects an object.

referencestringRequiredformat: "^\S+$"0-256 characters

namestring or nullOptionalformat: "^.*$"0-256 characters

descriptionstring or nullOptionalformat: "^.*$"0-256 characters

statusenum or nullOptional

The status of the meter indicating the activity of the meter and the ability to update properties.

Allowed values:

meter_valueslist of objects or nullOptional

The values used as input to calculate billable units, used in the meter.

meter_propertieslist of objects or nullOptional

The properties that provide information to give context to an event, used in the meter.

Response

referencestringformat: "^\S+$"0-256 characters

object_typestring or nullRead-only

idstring or nullRead-only

namestring or nullformat: "^.*$"0-256 characters

descriptionstring or nullformat: "^.*$"0-256 characters

statusenum or null

The status of the meter indicating the activity of the meter and the ability to update properties.

Allowed values:

meter_valueslist of objects or null

The values used as input to calculate billable units, used in the meter.

meter_propertieslist of objects or null

The properties that provide information to give context to an event, used in the meter.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors