Update Destination - m3ter Documentation

Update Destination

cURL

curl --request PUT \
  --url https://api.m3ter.com/organizations/{orgId}/integrationdestinations/webhooks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "url": "<string>",
  "credentials": {
    "type": "M3TER_SIGNED_REQUEST",
    "apiKey": "api key",
    "secret": "api secret",
    "version": 123,
    "empty": true,
    "name": "Integration Credentials"
  },
  "version": 123,
  "code": "<string>",
  "active": true
}
'

Python

import requests

url = "https://api.m3ter.com/organizations/{orgId}/integrationdestinations/webhooks/{id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "url": "<string>",
    "credentials": {
        "type": "M3TER_SIGNED_REQUEST",
        "apiKey": "api key",
        "secret": "api secret",
        "version": 123,
        "empty": True,
        "name": "Integration Credentials"
    },
    "version": 123,
    "code": "<string>",
    "active": True
}
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: '<string>',
    description: '<string>',
    url: '<string>',
    credentials: {
      type: 'M3TER_SIGNED_REQUEST',
      apiKey: 'api key',
      secret: 'api secret',
      version: 123,
      empty: true,
      name: 'Integration Credentials'
    },
    version: 123,
    code: '<string>',
    active: true
  })
};

fetch('https://api.m3ter.com/organizations/{orgId}/integrationdestinations/webhooks/{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}/integrationdestinations/webhooks/{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' => '<string>',
    'description' => '<string>',
    'url' => '<string>',
    'credentials' => [
        'type' => 'M3TER_SIGNED_REQUEST',
        'apiKey' => 'api key',
        'secret' => 'api secret',
        'version' => 123,
        'empty' => true,
        'name' => 'Integration Credentials'
    ],
    'version' => 123,
    'code' => '<string>',
    'active' => true
  ]),
  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}/integrationdestinations/webhooks/{id}"

payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"url\": \"<string>\",\n  \"credentials\": {\n    \"type\": \"M3TER_SIGNED_REQUEST\",\n    \"apiKey\": \"api key\",\n    \"secret\": \"api secret\",\n    \"version\": 123,\n    \"empty\": true,\n    \"name\": \"Integration Credentials\"\n  },\n  \"version\": 123,\n  \"code\": \"<string>\",\n  \"active\": true\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}/integrationdestinations/webhooks/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"url\": \"<string>\",\n  \"credentials\": {\n    \"type\": \"M3TER_SIGNED_REQUEST\",\n    \"apiKey\": \"api key\",\n    \"secret\": \"api secret\",\n    \"version\": 123,\n    \"empty\": true,\n    \"name\": \"Integration Credentials\"\n  },\n  \"version\": 123,\n  \"code\": \"<string>\",\n  \"active\": true\n}")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://api.m3ter.com/organizations/{orgId}/integrationdestinations/webhooks/{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\": \"<string>\",\n  \"description\": \"<string>\",\n  \"url\": \"<string>\",\n  \"credentials\": {\n    \"type\": \"M3TER_SIGNED_REQUEST\",\n    \"apiKey\": \"api key\",\n    \"secret\": \"api secret\",\n    \"version\": 123,\n    \"empty\": true,\n    \"name\": \"Integration Credentials\"\n  },\n  \"version\": 123,\n  \"code\": \"<string>\",\n  \"active\": true\n}"

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

Response Codes

• 200: Returns the Destination Update Request
• 4XX: Client error responses
• 5XX: Server error responses

Response Structure

{
  "id": "<string>",
  "version": 123,
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>",
  "name": "<string>",
  "description": "<string>",
  "code": "<string>",
  "active": true,
  "url": "<string>",
  "credentials": {
    "id": "<string>",
    "type": "<string>",
    "destination": "<string>",
    "version": 123,
    "dtCreated": "2023-11-07T05:31:56Z",
    "dtLastModified": "2023-11-07T05:31:56Z",
    "createdBy": "<string>",
    "lastModifiedBy": "<string>",
    "destinationId": "<string>",
    "name": "<string>",
    "apiKey": "api key",
    "secret": "api secret"
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}