Skip to main content
PATCH
/
claims
/
{id}
Update claim
curl --request PATCH \
  --url https://api.example.com/claims/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "customFields": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "name": "<string>",
  "description": "<string>",
  "occurredAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "responsibility": "<string>",
  "category": "<string>",
  "reserve": 123,
  "metadata": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ]
}
'
import requests

url = "https://api.example.com/claims/{id}"

payload = {
"customFields": [
{
"key": "<string>",
"value": "<string>"
}
],
"name": "<string>",
"description": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"responsibility": "<string>",
"category": "<string>",
"reserve": 123,
"metadata": [
{
"key": "<string>",
"value": "<string>"
}
]
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
customFields: [{key: '<string>', value: '<string>'}],
name: '<string>',
description: '<string>',
occurredAt: '2023-11-07T05:31:56Z',
createdAt: '2023-11-07T05:31:56Z',
responsibility: '<string>',
category: '<string>',
reserve: 123,
metadata: [{key: '<string>', value: '<string>'}]
})
};

fetch('https://api.example.com/claims/{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.example.com/claims/{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([
'customFields' => [
[
'key' => '<string>',
'value' => '<string>'
]
],
'name' => '<string>',
'description' => '<string>',
'occurredAt' => '2023-11-07T05:31:56Z',
'createdAt' => '2023-11-07T05:31:56Z',
'responsibility' => '<string>',
'category' => '<string>',
'reserve' => 123,
'metadata' => [
[
'key' => '<string>',
'value' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"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://api.example.com/claims/{id}"

payload := strings.NewReader("{\n \"customFields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"occurredAt\": \"2023-11-07T05:31:56Z\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"responsibility\": \"<string>\",\n \"category\": \"<string>\",\n \"reserve\": 123,\n \"metadata\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")

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

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.example.com/claims/{id}")
.header("Content-Type", "application/json")
.body("{\n \"customFields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"occurredAt\": \"2023-11-07T05:31:56Z\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"responsibility\": \"<string>\",\n \"category\": \"<string>\",\n \"reserve\": 123,\n \"metadata\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/claims/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"customFields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"occurredAt\": \"2023-11-07T05:31:56Z\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"responsibility\": \"<string>\",\n \"category\": \"<string>\",\n \"reserve\": 123,\n \"metadata\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "metadata": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "occurredAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "type": "<string>",
  "id": "<string>",
  "externalId": "<string>",
  "customFields": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "name": "<string>",
  "description": "<string>",
  "responsibility": "<string>",
  "category": "<string>",
  "reserve": 123
}

Path Parameters

id
string
required

Body

application/json
customFields
object[]

custom fields per product

name
string

Optional: Name of the entity

description
string
occurredAt
string<date-time>
createdAt
string<date-time>
responsibility
string
category
string

the amount of money that an insurance company sets aside to cover

reserve
number
metadata
object[]

metadata assigned to the object

Response

metadata
object[]
required

metadata assigned to the object

occurredAt
string<date-time>
required
createdAt
string<date-time>
required
type
string
required
id
string
required
externalId
string
required
customFields
object[]

custom fields per product

name
string

Optional: Name of the entity

description
string
responsibility
string
category
string

the amount of money that an insurance company sets aside to cover

reserve
number