Update ScheduledEventConfiguration - m3ter Documentation

Update ScheduledEventConfiguration

cURL

curl --request PUT \
  --url https://api.m3ter.com/organizations/{orgId}/scheduledevents/configurations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data ' \
{
  "name": "scheduled.bill.enddateEvent",
  "entity": "Bill",
  "field": "endDate",
  "offset": 5
}
'```

### Python

```python
import requests

url = "https://api.m3ter.com/organizations/{orgId}/scheduledevents/configurations/{id}"

payload = {
    "name": "scheduled.bill.enddateEvent",
    "entity": "Bill",
    "field": "endDate",
    "offset": 5
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

JavaScript

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'scheduled.bill.enddateEvent',
    entity: 'Bill',
    field: 'endDate',
    offset: 5
  })
};

fetch('https://api.m3ter.com/organizations/{orgId}/scheduledevents/configurations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.m3ter.com/organizations/{orgId}/scheduledevents/configurations/{id}",
  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' => 'scheduled.bill.enddateEvent',
    'entity' => 'Bill',
    'field' => 'endDate',
    'offset' => 5
  ]),
  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;
}
?>

Go

package main

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

func main() {

url := "https://api.m3ter.com/organizations/{orgId}/scheduledevents/configurations/{id}"

payload := strings.NewReader("{\n  \"name\": \"scheduled.bill.enddateEvent\",\n  \"entity\": \"Bill\",\n  \"field\": \"endDate\",\n  \"offset\": 5\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))
}

Java

HttpResponse<String> response = Unirest.put("https://api.m3ter.com/organizations/{orgId}/scheduledevents/configurations/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"scheduled.bill.enddateEvent\",\n  \"entity\": \"Bill\",\n  \"field\": \"endDate\",\n  \"offset\": 5\n}")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://api.m3ter.com/organizations/{orgId}/scheduledevents/configurations/{id}")

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\": \"scheduled.bill.enddateEvent\",\n  \"entity\": \"Bill\",\n  \"field\": \"endDate\",\n  \"offset\": 5\n}"

response = http.request(request)
puts response.read_body

Response

Successful Responses

• 200 OK

  • Returns the updated ScheduledEventConfiguration.
  • Example Response:

  {
    "id": "<string>",
    "name": "10 days after bill due date",
    "entity": "Bill",
    "field": "dueDate",
    "offset": 10,
    "version": 123,
    "dtCreated": "2023-11-07T05:31:56Z",
    "dtLastModified": "2023-11-07T05:31:56Z",
    "createdBy": "<string>",
    "lastModifiedBy": "<string>"
  }
  

• 4XX/5XX Errors

  • Example Error Response:

  {
    "message": "<string>"
  }
  

Request Parameters

Header Parameters

• Authorization: string (required)
  • Bearer token for authorization.

Body Parameters