Update complaint
curl --request PATCH \
--url http://localhost:3000/v2/complaints/{id} \
--header 'Content-Type: application/json' \
--header 'x-API-Key: <api-key>' \
--data '
{
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"chatId": "<string>",
"desc": "Updated complaint description with additional details",
"roomDescription": "Updated room location information",
"contactName": "John Smith Jr.",
"contact": {
"email": "jsmith@example.com",
"telephone": "<string>"
},
"priority": 3,
"images": [
"<string>"
],
"userId": "507f1f77bcf86cd799439014",
"comment": "Additional notes about the complaint resolution",
"response": "Thank you for your patience. The issue has been resolved.",
"customFields": {}
}
'import requests
url = "http://localhost:3000/v2/complaints/{id}"
payload = {
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"chatId": "<string>",
"desc": "Updated complaint description with additional details",
"roomDescription": "Updated room location information",
"contactName": "John Smith Jr.",
"contact": {
"email": "jsmith@example.com",
"telephone": "<string>"
},
"priority": 3,
"images": ["<string>"],
"userId": "507f1f77bcf86cd799439014",
"comment": "Additional notes about the complaint resolution",
"response": "Thank you for your patience. The issue has been resolved.",
"customFields": {}
}
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({
_id: '<string>',
number: 123,
companyId: '<string>',
status: {
status: 123,
createdAt: '2023-11-07T05:31:56Z',
createdBy: '<string>',
lastModifiedAt: '2023-11-07T05:31:56Z',
lastModifiedBy: '<string>'
},
chatId: '<string>',
desc: 'Updated complaint description with additional details',
roomDescription: 'Updated room location information',
contactName: 'John Smith Jr.',
contact: {email: 'jsmith@example.com', telephone: '<string>'},
priority: 3,
images: ['<string>'],
userId: '507f1f77bcf86cd799439014',
comment: 'Additional notes about the complaint resolution',
response: 'Thank you for your patience. The issue has been resolved.',
customFields: {}
})
};
fetch('http://localhost:3000/v2/complaints/{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_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/complaints/{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([
'_id' => '<string>',
'number' => 123,
'companyId' => '<string>',
'status' => [
'status' => 123,
'createdAt' => '2023-11-07T05:31:56Z',
'createdBy' => '<string>',
'lastModifiedAt' => '2023-11-07T05:31:56Z',
'lastModifiedBy' => '<string>'
],
'chatId' => '<string>',
'desc' => 'Updated complaint description with additional details',
'roomDescription' => 'Updated room location information',
'contactName' => 'John Smith Jr.',
'contact' => [
'email' => 'jsmith@example.com',
'telephone' => '<string>'
],
'priority' => 3,
'images' => [
'<string>'
],
'userId' => '507f1f77bcf86cd799439014',
'comment' => 'Additional notes about the complaint resolution',
'response' => 'Thank you for your patience. The issue has been resolved.',
'customFields' => [
]
]),
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 := "http://localhost:3000/v2/complaints/{id}"
payload := strings.NewReader("{\n \"_id\": \"<string>\",\n \"number\": 123,\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 },\n \"chatId\": \"<string>\",\n \"desc\": \"Updated complaint description with additional details\",\n \"roomDescription\": \"Updated room location information\",\n \"contactName\": \"John Smith Jr.\",\n \"contact\": {\n \"email\": \"jsmith@example.com\",\n \"telephone\": \"<string>\"\n },\n \"priority\": 3,\n \"images\": [\n \"<string>\"\n ],\n \"userId\": \"507f1f77bcf86cd799439014\",\n \"comment\": \"Additional notes about the complaint resolution\",\n \"response\": \"Thank you for your patience. The issue has been resolved.\",\n \"customFields\": {}\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("http://localhost:3000/v2/complaints/{id}")
.header("x-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"_id\": \"<string>\",\n \"number\": 123,\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 },\n \"chatId\": \"<string>\",\n \"desc\": \"Updated complaint description with additional details\",\n \"roomDescription\": \"Updated room location information\",\n \"contactName\": \"John Smith Jr.\",\n \"contact\": {\n \"email\": \"jsmith@example.com\",\n \"telephone\": \"<string>\"\n },\n \"priority\": 3,\n \"images\": [\n \"<string>\"\n ],\n \"userId\": \"507f1f77bcf86cd799439014\",\n \"comment\": \"Additional notes about the complaint resolution\",\n \"response\": \"Thank you for your patience. The issue has been resolved.\",\n \"customFields\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/complaints/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["x-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"_id\": \"<string>\",\n \"number\": 123,\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 },\n \"chatId\": \"<string>\",\n \"desc\": \"Updated complaint description with additional details\",\n \"roomDescription\": \"Updated room location information\",\n \"contactName\": \"John Smith Jr.\",\n \"contact\": {\n \"email\": \"jsmith@example.com\",\n \"telephone\": \"<string>\"\n },\n \"priority\": 3,\n \"images\": [\n \"<string>\"\n ],\n \"userId\": \"507f1f77bcf86cd799439014\",\n \"comment\": \"Additional notes about the complaint resolution\",\n \"response\": \"Thank you for your patience. The issue has been resolved.\",\n \"customFields\": {}\n}"
response = http.request(request)
puts response.read_body{
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"chatId": "<string>",
"desc": "Updated complaint description with additional details",
"roomDescription": "Updated room location information",
"contactName": "John Smith Jr.",
"contact": {
"email": "jsmith@example.com",
"telephone": "<string>"
},
"priority": 3,
"images": [
"<string>"
],
"userId": "507f1f77bcf86cd799439014",
"comment": "Additional notes about the complaint resolution",
"response": "Thank you for your patience. The issue has been resolved.",
"customFields": {}
}Tickets
Update Ticket
Update an existing complaint with new information, status changes, or additional details.
PATCH
/
complaints
/
{id}
Update complaint
curl --request PATCH \
--url http://localhost:3000/v2/complaints/{id} \
--header 'Content-Type: application/json' \
--header 'x-API-Key: <api-key>' \
--data '
{
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"chatId": "<string>",
"desc": "Updated complaint description with additional details",
"roomDescription": "Updated room location information",
"contactName": "John Smith Jr.",
"contact": {
"email": "jsmith@example.com",
"telephone": "<string>"
},
"priority": 3,
"images": [
"<string>"
],
"userId": "507f1f77bcf86cd799439014",
"comment": "Additional notes about the complaint resolution",
"response": "Thank you for your patience. The issue has been resolved.",
"customFields": {}
}
'import requests
url = "http://localhost:3000/v2/complaints/{id}"
payload = {
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"chatId": "<string>",
"desc": "Updated complaint description with additional details",
"roomDescription": "Updated room location information",
"contactName": "John Smith Jr.",
"contact": {
"email": "jsmith@example.com",
"telephone": "<string>"
},
"priority": 3,
"images": ["<string>"],
"userId": "507f1f77bcf86cd799439014",
"comment": "Additional notes about the complaint resolution",
"response": "Thank you for your patience. The issue has been resolved.",
"customFields": {}
}
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({
_id: '<string>',
number: 123,
companyId: '<string>',
status: {
status: 123,
createdAt: '2023-11-07T05:31:56Z',
createdBy: '<string>',
lastModifiedAt: '2023-11-07T05:31:56Z',
lastModifiedBy: '<string>'
},
chatId: '<string>',
desc: 'Updated complaint description with additional details',
roomDescription: 'Updated room location information',
contactName: 'John Smith Jr.',
contact: {email: 'jsmith@example.com', telephone: '<string>'},
priority: 3,
images: ['<string>'],
userId: '507f1f77bcf86cd799439014',
comment: 'Additional notes about the complaint resolution',
response: 'Thank you for your patience. The issue has been resolved.',
customFields: {}
})
};
fetch('http://localhost:3000/v2/complaints/{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_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/complaints/{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([
'_id' => '<string>',
'number' => 123,
'companyId' => '<string>',
'status' => [
'status' => 123,
'createdAt' => '2023-11-07T05:31:56Z',
'createdBy' => '<string>',
'lastModifiedAt' => '2023-11-07T05:31:56Z',
'lastModifiedBy' => '<string>'
],
'chatId' => '<string>',
'desc' => 'Updated complaint description with additional details',
'roomDescription' => 'Updated room location information',
'contactName' => 'John Smith Jr.',
'contact' => [
'email' => 'jsmith@example.com',
'telephone' => '<string>'
],
'priority' => 3,
'images' => [
'<string>'
],
'userId' => '507f1f77bcf86cd799439014',
'comment' => 'Additional notes about the complaint resolution',
'response' => 'Thank you for your patience. The issue has been resolved.',
'customFields' => [
]
]),
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 := "http://localhost:3000/v2/complaints/{id}"
payload := strings.NewReader("{\n \"_id\": \"<string>\",\n \"number\": 123,\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 },\n \"chatId\": \"<string>\",\n \"desc\": \"Updated complaint description with additional details\",\n \"roomDescription\": \"Updated room location information\",\n \"contactName\": \"John Smith Jr.\",\n \"contact\": {\n \"email\": \"jsmith@example.com\",\n \"telephone\": \"<string>\"\n },\n \"priority\": 3,\n \"images\": [\n \"<string>\"\n ],\n \"userId\": \"507f1f77bcf86cd799439014\",\n \"comment\": \"Additional notes about the complaint resolution\",\n \"response\": \"Thank you for your patience. The issue has been resolved.\",\n \"customFields\": {}\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("http://localhost:3000/v2/complaints/{id}")
.header("x-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"_id\": \"<string>\",\n \"number\": 123,\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 },\n \"chatId\": \"<string>\",\n \"desc\": \"Updated complaint description with additional details\",\n \"roomDescription\": \"Updated room location information\",\n \"contactName\": \"John Smith Jr.\",\n \"contact\": {\n \"email\": \"jsmith@example.com\",\n \"telephone\": \"<string>\"\n },\n \"priority\": 3,\n \"images\": [\n \"<string>\"\n ],\n \"userId\": \"507f1f77bcf86cd799439014\",\n \"comment\": \"Additional notes about the complaint resolution\",\n \"response\": \"Thank you for your patience. The issue has been resolved.\",\n \"customFields\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/complaints/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["x-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"_id\": \"<string>\",\n \"number\": 123,\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 },\n \"chatId\": \"<string>\",\n \"desc\": \"Updated complaint description with additional details\",\n \"roomDescription\": \"Updated room location information\",\n \"contactName\": \"John Smith Jr.\",\n \"contact\": {\n \"email\": \"jsmith@example.com\",\n \"telephone\": \"<string>\"\n },\n \"priority\": 3,\n \"images\": [\n \"<string>\"\n ],\n \"userId\": \"507f1f77bcf86cd799439014\",\n \"comment\": \"Additional notes about the complaint resolution\",\n \"response\": \"Thank you for your patience. The issue has been resolved.\",\n \"customFields\": {}\n}"
response = http.request(request)
puts response.read_body{
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"chatId": "<string>",
"desc": "Updated complaint description with additional details",
"roomDescription": "Updated room location information",
"contactName": "John Smith Jr.",
"contact": {
"email": "jsmith@example.com",
"telephone": "<string>"
},
"priority": 3,
"images": [
"<string>"
],
"userId": "507f1f77bcf86cd799439014",
"comment": "Additional notes about the complaint resolution",
"response": "Thank you for your patience. The issue has been resolved.",
"customFields": {}
}Authorizations
API-KeyBearer-Auth
Path Parameters
Complaint ID
Body
application/json
Complaint data to update
Data that can be updated for an existing complaint
Unique identifier of the entity
Unique number of the entity, used for identification
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
Updated description of the complaint
Example:
"Updated complaint description with additional details"
Updated room description
Example:
"Updated room location information"
Updated contact name
Example:
"John Smith Jr."
Updated contact information
Show child attributes
Show child attributes
Updated priority level (1=Low, 2=Medium, 3=High, 4=Critical)
Required range:
1 <= x <= 4Example:
3
Updated images for the complaint
ID of the user to assign/reassign this complaint to
Example:
"507f1f77bcf86cd799439014"
Internal comment about the complaint
Example:
"Additional notes about the complaint resolution"
Customer response message
Example:
"Thank you for your patience. The issue has been resolved."
Updated custom field values
Response
Complaint updated successfully
Data that can be updated for an existing complaint
Unique identifier of the entity
Unique number of the entity, used for identification
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
Updated description of the complaint
Example:
"Updated complaint description with additional details"
Updated room description
Example:
"Updated room location information"
Updated contact name
Example:
"John Smith Jr."
Updated contact information
Show child attributes
Show child attributes
Updated priority level (1=Low, 2=Medium, 3=High, 4=Critical)
Required range:
1 <= x <= 4Example:
3
Updated images for the complaint
ID of the user to assign/reassign this complaint to
Example:
"507f1f77bcf86cd799439014"
Internal comment about the complaint
Example:
"Additional notes about the complaint resolution"
Customer response message
Example:
"Thank you for your patience. The issue has been resolved."
Updated custom field values
Was this page helpful?
⌘I