Edit Policy
curl --request PATCH \
--url https://api.example.com/policies/{policyId} \
--header 'Content-Type: application/json' \
--data '
{
"customFields": [
{
"key": "<string>",
"value": "<string>"
}
],
"name": "<string>",
"acceptedEmailDomains": [
"<string>"
],
"maximumNumberOfBikes": 2
}
'import requests
url = "https://api.example.com/policies/{policyId}"
payload = {
"customFields": [
{
"key": "<string>",
"value": "<string>"
}
],
"name": "<string>",
"acceptedEmailDomains": ["<string>"],
"maximumNumberOfBikes": 2
}
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>',
acceptedEmailDomains: ['<string>'],
maximumNumberOfBikes: 2
})
};
fetch('https://api.example.com/policies/{policyId}', 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/policies/{policyId}",
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>',
'acceptedEmailDomains' => [
'<string>'
],
'maximumNumberOfBikes' => 2
]),
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/policies/{policyId}"
payload := strings.NewReader("{\n \"customFields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"acceptedEmailDomains\": [\n \"<string>\"\n ],\n \"maximumNumberOfBikes\": 2\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/policies/{policyId}")
.header("Content-Type", "application/json")
.body("{\n \"customFields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"acceptedEmailDomains\": [\n \"<string>\"\n ],\n \"maximumNumberOfBikes\": 2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/policies/{policyId}")
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 \"acceptedEmailDomains\": [\n \"<string>\"\n ],\n \"maximumNumberOfBikes\": 2\n}"
response = http.request(request)
puts response.read_body{}
policy
Edit Policy
PATCH
/
policies
/
{policyId}
Edit Policy
curl --request PATCH \
--url https://api.example.com/policies/{policyId} \
--header 'Content-Type: application/json' \
--data '
{
"customFields": [
{
"key": "<string>",
"value": "<string>"
}
],
"name": "<string>",
"acceptedEmailDomains": [
"<string>"
],
"maximumNumberOfBikes": 2
}
'import requests
url = "https://api.example.com/policies/{policyId}"
payload = {
"customFields": [
{
"key": "<string>",
"value": "<string>"
}
],
"name": "<string>",
"acceptedEmailDomains": ["<string>"],
"maximumNumberOfBikes": 2
}
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>',
acceptedEmailDomains: ['<string>'],
maximumNumberOfBikes: 2
})
};
fetch('https://api.example.com/policies/{policyId}', 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/policies/{policyId}",
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>',
'acceptedEmailDomains' => [
'<string>'
],
'maximumNumberOfBikes' => 2
]),
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/policies/{policyId}"
payload := strings.NewReader("{\n \"customFields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"acceptedEmailDomains\": [\n \"<string>\"\n ],\n \"maximumNumberOfBikes\": 2\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/policies/{policyId}")
.header("Content-Type", "application/json")
.body("{\n \"customFields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"acceptedEmailDomains\": [\n \"<string>\"\n ],\n \"maximumNumberOfBikes\": 2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/policies/{policyId}")
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 \"acceptedEmailDomains\": [\n \"<string>\"\n ],\n \"maximumNumberOfBikes\": 2\n}"
response = http.request(request)
puts response.read_body{}
Path Parameters
the policy's id
Body
application/json
custom fields per product
Show child attributes
Show child attributes
Optional: Name of the entity
the policy's invoicing configuration
Show child attributes
Show child attributes
the policy's period duration
Show child attributes
Show child attributes
the child policy's customer accepted email domains
Show child attributes
Show child attributes
max number of bike
Required range:
x >= 1Response
The response is of type object.
Was this page helpful?
⌘I

