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": {}
}'
{
  "_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

​
x-API-Key
string
header
required

Path Parameters

​
id
string<objectid>
required

Complaint ID

Body

application/json

Complaint data to update

Data that can be updated for an existing complaint Base class for all entities that can have a chat associated with them. Base class for all entities in the system, providing common properties and methods.

Response

200
application/json

Complaint updated successfully

Data that can be updated for an existing complaint Base class for all entities that can have a chat associated with them. Base class for all entities in the system, providing common properties and methods.