Skip to main content
GET
Get complaint by ID

Path Parameters

id
string<objectid>
required

Complaint ID

Response

Complaint retrieved successfully

Data that can be updated for an existing complaint

_id
string<objectid>

Unique identifier of the entity

number
integer

Unique number of the entity, used for identification

companyId
string<objectid>

The ID of the company this entity belongs to

status
object

Entity Status information

chatId
string<objectid> | null

ID of the chat associated with this entity

desc
string

Updated description of the complaint

Example:

"Updated complaint description with additional details"

roomDescription
string

Updated room description

Example:

"Updated room location information"

contactName
string

Updated contact name

Example:

"John Smith Jr."

contact
object

Updated contact information

priority
integer

Updated priority level (1=Low, 2=Medium, 3=High, 4=Critical)

Required range: 1 <= x <= 4
Example:

3

images
string<uri>[]

Updated images for the complaint

userId
string<objectid> | null

ID of the user to assign/reassign this complaint to

Example:

"507f1f77bcf86cd799439014"

comment
string

Internal comment about the complaint

Example:

"Additional notes about the complaint resolution"

response
string

Customer response message

Example:

"Thank you for your patience. The issue has been resolved."

customFields
object | null

Updated custom field values