Update customer object
curl --request PATCH \
--url https://cloud-api.pland.app/v2/objects/{id} \
--header 'Content-Type: application/json' \
--header 'x-API-Key: <api-key>' \
--data '
{
"number": 123,
"customerId": "<string>",
"address": {
"street": "<string>",
"zip": "<string>",
"city": "<string>",
"country": "<string>"
},
"_id": "<string>",
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>",
"agentId": "<string>",
"assistantId": "<string>"
},
"chatId": "<string>",
"name": "<string>",
"contact": {
"phone": "<string>",
"email": "jsmith@example.com"
},
"contract": {
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z"
},
"objectManagerId": "<string>",
"material": [
{
"articleId": "<string>",
"budget": 123
}
],
"location": {
"latitude": 123,
"longitude": 123
},
"rating": 2.5,
"description": "<string>",
"securityCode": "<unknown>",
"key": "<unknown>",
"orderDescription": "<string>",
"contactName": "<string>",
"serviceRecipient": "<string>",
"tags": [
"<string>"
]
}
'import requests
url = "https://cloud-api.pland.app/v2/objects/{id}"
payload = {
"number": 123,
"customerId": "<string>",
"address": {
"street": "<string>",
"zip": "<string>",
"city": "<string>",
"country": "<string>"
},
"_id": "<string>",
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>",
"agentId": "<string>",
"assistantId": "<string>"
},
"chatId": "<string>",
"name": "<string>",
"contact": {
"phone": "<string>",
"email": "jsmith@example.com"
},
"contract": {
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z"
},
"objectManagerId": "<string>",
"material": [
{
"articleId": "<string>",
"budget": 123
}
],
"location": {
"latitude": 123,
"longitude": 123
},
"rating": 2.5,
"description": "<string>",
"securityCode": "<unknown>",
"key": "<unknown>",
"orderDescription": "<string>",
"contactName": "<string>",
"serviceRecipient": "<string>",
"tags": ["<string>"]
}
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: 123,
customerId: '<string>',
address: {street: '<string>', zip: '<string>', city: '<string>', country: '<string>'},
_id: '<string>',
companyId: '<string>',
status: {
status: 123,
createdAt: '2023-11-07T05:31:56Z',
createdBy: '<string>',
lastModifiedAt: '2023-11-07T05:31:56Z',
lastModifiedBy: '<string>',
agentId: '<string>',
assistantId: '<string>'
},
chatId: '<string>',
name: '<string>',
contact: {phone: '<string>', email: 'jsmith@example.com'},
contract: {startDate: '2023-11-07T05:31:56Z', endDate: '2023-11-07T05:31:56Z'},
objectManagerId: '<string>',
material: [{articleId: '<string>', budget: 123}],
location: {latitude: 123, longitude: 123},
rating: 2.5,
description: '<string>',
securityCode: '<unknown>',
key: '<unknown>',
orderDescription: '<string>',
contactName: '<string>',
serviceRecipient: '<string>',
tags: ['<string>']
})
};
fetch('https://cloud-api.pland.app/v2/objects/{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://cloud-api.pland.app/v2/objects/{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' => 123,
'customerId' => '<string>',
'address' => [
'street' => '<string>',
'zip' => '<string>',
'city' => '<string>',
'country' => '<string>'
],
'_id' => '<string>',
'companyId' => '<string>',
'status' => [
'status' => 123,
'createdAt' => '2023-11-07T05:31:56Z',
'createdBy' => '<string>',
'lastModifiedAt' => '2023-11-07T05:31:56Z',
'lastModifiedBy' => '<string>',
'agentId' => '<string>',
'assistantId' => '<string>'
],
'chatId' => '<string>',
'name' => '<string>',
'contact' => [
'phone' => '<string>',
'email' => 'jsmith@example.com'
],
'contract' => [
'startDate' => '2023-11-07T05:31:56Z',
'endDate' => '2023-11-07T05:31:56Z'
],
'objectManagerId' => '<string>',
'material' => [
[
'articleId' => '<string>',
'budget' => 123
]
],
'location' => [
'latitude' => 123,
'longitude' => 123
],
'rating' => 2.5,
'description' => '<string>',
'securityCode' => '<unknown>',
'key' => '<unknown>',
'orderDescription' => '<string>',
'contactName' => '<string>',
'serviceRecipient' => '<string>',
'tags' => [
'<string>'
]
]),
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://cloud-api.pland.app/v2/objects/{id}"
payload := strings.NewReader("{\n \"number\": 123,\n \"customerId\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"_id\": \"<string>\",\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\",\n \"agentId\": \"<string>\",\n \"assistantId\": \"<string>\"\n },\n \"chatId\": \"<string>\",\n \"name\": \"<string>\",\n \"contact\": {\n \"phone\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n },\n \"contract\": {\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\"\n },\n \"objectManagerId\": \"<string>\",\n \"material\": [\n {\n \"articleId\": \"<string>\",\n \"budget\": 123\n }\n ],\n \"location\": {\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"rating\": 2.5,\n \"description\": \"<string>\",\n \"securityCode\": \"<unknown>\",\n \"key\": \"<unknown>\",\n \"orderDescription\": \"<string>\",\n \"contactName\": \"<string>\",\n \"serviceRecipient\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\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://cloud-api.pland.app/v2/objects/{id}")
.header("x-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"number\": 123,\n \"customerId\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"_id\": \"<string>\",\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\",\n \"agentId\": \"<string>\",\n \"assistantId\": \"<string>\"\n },\n \"chatId\": \"<string>\",\n \"name\": \"<string>\",\n \"contact\": {\n \"phone\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n },\n \"contract\": {\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\"\n },\n \"objectManagerId\": \"<string>\",\n \"material\": [\n {\n \"articleId\": \"<string>\",\n \"budget\": 123\n }\n ],\n \"location\": {\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"rating\": 2.5,\n \"description\": \"<string>\",\n \"securityCode\": \"<unknown>\",\n \"key\": \"<unknown>\",\n \"orderDescription\": \"<string>\",\n \"contactName\": \"<string>\",\n \"serviceRecipient\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud-api.pland.app/v2/objects/{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\": 123,\n \"customerId\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"_id\": \"<string>\",\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\",\n \"agentId\": \"<string>\",\n \"assistantId\": \"<string>\"\n },\n \"chatId\": \"<string>\",\n \"name\": \"<string>\",\n \"contact\": {\n \"phone\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n },\n \"contract\": {\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\"\n },\n \"objectManagerId\": \"<string>\",\n \"material\": [\n {\n \"articleId\": \"<string>\",\n \"budget\": 123\n }\n ],\n \"location\": {\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"rating\": 2.5,\n \"description\": \"<string>\",\n \"securityCode\": \"<unknown>\",\n \"key\": \"<unknown>\",\n \"orderDescription\": \"<string>\",\n \"contactName\": \"<string>\",\n \"serviceRecipient\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"number": 123,
"customerId": "<string>",
"address": {
"street": "<string>",
"zip": "<string>",
"city": "<string>",
"country": "<string>"
},
"_id": "<string>",
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>",
"agentId": "<string>",
"assistantId": "<string>"
},
"chatId": "<string>",
"name": "<string>",
"contact": {
"phone": "<string>",
"email": "jsmith@example.com"
},
"contract": {
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z"
},
"objectManagerId": "<string>",
"material": [
{
"articleId": "<string>",
"budget": 123
}
],
"location": {
"latitude": 123,
"longitude": 123
},
"rating": 2.5,
"description": "<string>",
"securityCode": "<unknown>",
"key": "<unknown>",
"orderDescription": "<string>",
"contactName": "<string>",
"serviceRecipient": "<string>",
"tags": [
"<string>"
]
}Objects
Update Object
Update an existing customer object with new information. Only provided fields will be updated.
PATCH
/
objects
/
{id}
Update customer object
curl --request PATCH \
--url https://cloud-api.pland.app/v2/objects/{id} \
--header 'Content-Type: application/json' \
--header 'x-API-Key: <api-key>' \
--data '
{
"number": 123,
"customerId": "<string>",
"address": {
"street": "<string>",
"zip": "<string>",
"city": "<string>",
"country": "<string>"
},
"_id": "<string>",
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>",
"agentId": "<string>",
"assistantId": "<string>"
},
"chatId": "<string>",
"name": "<string>",
"contact": {
"phone": "<string>",
"email": "jsmith@example.com"
},
"contract": {
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z"
},
"objectManagerId": "<string>",
"material": [
{
"articleId": "<string>",
"budget": 123
}
],
"location": {
"latitude": 123,
"longitude": 123
},
"rating": 2.5,
"description": "<string>",
"securityCode": "<unknown>",
"key": "<unknown>",
"orderDescription": "<string>",
"contactName": "<string>",
"serviceRecipient": "<string>",
"tags": [
"<string>"
]
}
'import requests
url = "https://cloud-api.pland.app/v2/objects/{id}"
payload = {
"number": 123,
"customerId": "<string>",
"address": {
"street": "<string>",
"zip": "<string>",
"city": "<string>",
"country": "<string>"
},
"_id": "<string>",
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>",
"agentId": "<string>",
"assistantId": "<string>"
},
"chatId": "<string>",
"name": "<string>",
"contact": {
"phone": "<string>",
"email": "jsmith@example.com"
},
"contract": {
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z"
},
"objectManagerId": "<string>",
"material": [
{
"articleId": "<string>",
"budget": 123
}
],
"location": {
"latitude": 123,
"longitude": 123
},
"rating": 2.5,
"description": "<string>",
"securityCode": "<unknown>",
"key": "<unknown>",
"orderDescription": "<string>",
"contactName": "<string>",
"serviceRecipient": "<string>",
"tags": ["<string>"]
}
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: 123,
customerId: '<string>',
address: {street: '<string>', zip: '<string>', city: '<string>', country: '<string>'},
_id: '<string>',
companyId: '<string>',
status: {
status: 123,
createdAt: '2023-11-07T05:31:56Z',
createdBy: '<string>',
lastModifiedAt: '2023-11-07T05:31:56Z',
lastModifiedBy: '<string>',
agentId: '<string>',
assistantId: '<string>'
},
chatId: '<string>',
name: '<string>',
contact: {phone: '<string>', email: 'jsmith@example.com'},
contract: {startDate: '2023-11-07T05:31:56Z', endDate: '2023-11-07T05:31:56Z'},
objectManagerId: '<string>',
material: [{articleId: '<string>', budget: 123}],
location: {latitude: 123, longitude: 123},
rating: 2.5,
description: '<string>',
securityCode: '<unknown>',
key: '<unknown>',
orderDescription: '<string>',
contactName: '<string>',
serviceRecipient: '<string>',
tags: ['<string>']
})
};
fetch('https://cloud-api.pland.app/v2/objects/{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://cloud-api.pland.app/v2/objects/{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' => 123,
'customerId' => '<string>',
'address' => [
'street' => '<string>',
'zip' => '<string>',
'city' => '<string>',
'country' => '<string>'
],
'_id' => '<string>',
'companyId' => '<string>',
'status' => [
'status' => 123,
'createdAt' => '2023-11-07T05:31:56Z',
'createdBy' => '<string>',
'lastModifiedAt' => '2023-11-07T05:31:56Z',
'lastModifiedBy' => '<string>',
'agentId' => '<string>',
'assistantId' => '<string>'
],
'chatId' => '<string>',
'name' => '<string>',
'contact' => [
'phone' => '<string>',
'email' => 'jsmith@example.com'
],
'contract' => [
'startDate' => '2023-11-07T05:31:56Z',
'endDate' => '2023-11-07T05:31:56Z'
],
'objectManagerId' => '<string>',
'material' => [
[
'articleId' => '<string>',
'budget' => 123
]
],
'location' => [
'latitude' => 123,
'longitude' => 123
],
'rating' => 2.5,
'description' => '<string>',
'securityCode' => '<unknown>',
'key' => '<unknown>',
'orderDescription' => '<string>',
'contactName' => '<string>',
'serviceRecipient' => '<string>',
'tags' => [
'<string>'
]
]),
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://cloud-api.pland.app/v2/objects/{id}"
payload := strings.NewReader("{\n \"number\": 123,\n \"customerId\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"_id\": \"<string>\",\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\",\n \"agentId\": \"<string>\",\n \"assistantId\": \"<string>\"\n },\n \"chatId\": \"<string>\",\n \"name\": \"<string>\",\n \"contact\": {\n \"phone\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n },\n \"contract\": {\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\"\n },\n \"objectManagerId\": \"<string>\",\n \"material\": [\n {\n \"articleId\": \"<string>\",\n \"budget\": 123\n }\n ],\n \"location\": {\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"rating\": 2.5,\n \"description\": \"<string>\",\n \"securityCode\": \"<unknown>\",\n \"key\": \"<unknown>\",\n \"orderDescription\": \"<string>\",\n \"contactName\": \"<string>\",\n \"serviceRecipient\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\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://cloud-api.pland.app/v2/objects/{id}")
.header("x-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"number\": 123,\n \"customerId\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"_id\": \"<string>\",\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\",\n \"agentId\": \"<string>\",\n \"assistantId\": \"<string>\"\n },\n \"chatId\": \"<string>\",\n \"name\": \"<string>\",\n \"contact\": {\n \"phone\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n },\n \"contract\": {\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\"\n },\n \"objectManagerId\": \"<string>\",\n \"material\": [\n {\n \"articleId\": \"<string>\",\n \"budget\": 123\n }\n ],\n \"location\": {\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"rating\": 2.5,\n \"description\": \"<string>\",\n \"securityCode\": \"<unknown>\",\n \"key\": \"<unknown>\",\n \"orderDescription\": \"<string>\",\n \"contactName\": \"<string>\",\n \"serviceRecipient\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud-api.pland.app/v2/objects/{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\": 123,\n \"customerId\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"_id\": \"<string>\",\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\",\n \"agentId\": \"<string>\",\n \"assistantId\": \"<string>\"\n },\n \"chatId\": \"<string>\",\n \"name\": \"<string>\",\n \"contact\": {\n \"phone\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n },\n \"contract\": {\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\"\n },\n \"objectManagerId\": \"<string>\",\n \"material\": [\n {\n \"articleId\": \"<string>\",\n \"budget\": 123\n }\n ],\n \"location\": {\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"rating\": 2.5,\n \"description\": \"<string>\",\n \"securityCode\": \"<unknown>\",\n \"key\": \"<unknown>\",\n \"orderDescription\": \"<string>\",\n \"contactName\": \"<string>\",\n \"serviceRecipient\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"number": 123,
"customerId": "<string>",
"address": {
"street": "<string>",
"zip": "<string>",
"city": "<string>",
"country": "<string>"
},
"_id": "<string>",
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>",
"agentId": "<string>",
"assistantId": "<string>"
},
"chatId": "<string>",
"name": "<string>",
"contact": {
"phone": "<string>",
"email": "jsmith@example.com"
},
"contract": {
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z"
},
"objectManagerId": "<string>",
"material": [
{
"articleId": "<string>",
"budget": 123
}
],
"location": {
"latitude": 123,
"longitude": 123
},
"rating": 2.5,
"description": "<string>",
"securityCode": "<unknown>",
"key": "<unknown>",
"orderDescription": "<string>",
"contactName": "<string>",
"serviceRecipient": "<string>",
"tags": [
"<string>"
]
}Authorizations
API-KeyBearer-Auth
Path Parameters
Customer object ID
Body
application/json
Customer object data to update
A customer object represents a location or building where services are performed
Unique number of the entity, used for identification
The Customer this object belongs to
Physical address of the object
Show child attributes
Show child attributes
Unique identifier of the entity
The ID of the company this entity belongs to
Entity Status information
Show child attributes
Show child attributes
ID of the chat associated with this entity
Name of the customer object
Contact information for the object
Show child attributes
Show child attributes
Contract start and end date
Show child attributes
Show child attributes
The user responsible for managing this object
Material closet items for this object
Show child attributes
Show child attributes
GPS coordinates of the object
Show child attributes
Show child attributes
Quality rating of the object
Required range:
0 <= x <= 5Additional description or notes
Security access code for the object
Key information or access details
Order-specific description
Name of the contact person at the object
Service recipient information
Tags associated with the object
Response
Customer object updated successfully
A customer object represents a location or building where services are performed
Unique number of the entity, used for identification
The Customer this object belongs to
Physical address of the object
Show child attributes
Show child attributes
Unique identifier of the entity
The ID of the company this entity belongs to
Entity Status information
Show child attributes
Show child attributes
ID of the chat associated with this entity
Name of the customer object
Contact information for the object
Show child attributes
Show child attributes
Contract start and end date
Show child attributes
Show child attributes
The user responsible for managing this object
Material closet items for this object
Show child attributes
Show child attributes
GPS coordinates of the object
Show child attributes
Show child attributes
Quality rating of the object
Required range:
0 <= x <= 5Additional description or notes
Security access code for the object
Key information or access details
Order-specific description
Name of the contact person at the object
Service recipient information
Tags associated with the object
Was this page helpful?