Zum Hauptinhalt springen
PATCH
/
invoice-dimensions
/
options
/
{id}
Dimension-Option aktualisieren
curl --request PATCH \
  --url https://api.comstruct.com/v1/invoice-dimensions/options/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "number": "<string>",
  "title": "<string>",
  "description": "<string>",
  "is_active": true,
  "is_favorite": true
}
'
import requests

url = "https://api.comstruct.com/v1/invoice-dimensions/options/{id}"

payload = {
"number": "<string>",
"title": "<string>",
"description": "<string>",
"is_active": True,
"is_favorite": True
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
number: '<string>',
title: '<string>',
description: '<string>',
is_active: true,
is_favorite: true
})
};

fetch('https://api.comstruct.com/v1/invoice-dimensions/options/{id}', 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://api.comstruct.com/v1/invoice-dimensions/options/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'number' => '<string>',
'title' => '<string>',
'description' => '<string>',
'is_active' => true,
'is_favorite' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);

$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://api.comstruct.com/v1/invoice-dimensions/options/{id}"

payload := strings.NewReader("{\n \"number\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"is_active\": true,\n \"is_favorite\": true\n}")

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

req.Header.Add("X-API-Key", "<api-key>")
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.patch("https://api.comstruct.com/v1/invoice-dimensions/options/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"number\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"is_active\": true,\n \"is_favorite\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.comstruct.com/v1/invoice-dimensions/options/{id}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"number\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"is_active\": true,\n \"is_favorite\": true\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "number": "<string>",
  "title": "<string>",
  "description": "<string>",
  "is_active": true,
  "is_favorite": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Autorisierungen

X-API-Key
string
header
erforderlich

API-Schlüssel zur Authentifizierung. Kontaktieren Sie Ihren Customer Success Manager, um einen API-Schlüssel zu erhalten.

Jeder Endpunkt erfordert spezifische Berechtigungen (Scopes); die erforderlichen Scopes werden pro Endpunkt angezeigt.

Pfadparameter

id
string<uuid>
erforderlich

Body

application/json
number
string
title
string
description
string
is_active
boolean
is_favorite
boolean

Antwort

Option aktualisiert

id
string<uuid>
dimension_id
string<uuid>
number
string
title
string
description
string | null
is_active
boolean
is_favorite
boolean
created_at
string<date-time>
updated_at
string<date-time>