Skip to main content
PATCH
/
v2
/
inquiries
/
{id}
Update inquiry by id
curl --request PATCH \
  --url https://api.carecycle.ai/v2/inquiries/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "resolutionType": "<string>",
  "response": "<string>",
  "status": "new",
  "notes": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "<unknown>",
  "updatedAt": "<unknown>",
  "customerCampaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "callId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "inquiry": "<string>",
  "response": "<string>",
  "status": "new",
  "primaryCategory": "<string>",
  "subcategory": "<string>",
  "severity": "<string>",
  "severityTriggers": "<string>",
  "suggestedHandling": "<string>",
  "handlingRationale": "<string>",
  "reasoning": "<string>",
  "escalationApplied": true,
  "additionalConcerns": "<string>",
  "resolutionType": "<string>",
  "notes": "<string>",
  "resolvedAt": "<unknown>",
  "resolvedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

x-api-key
string
header
required

API key required for authentication.

Keys begin with 'cc_' prefix. Get your API key from the Developer Dashboard.

Path Parameters

id
string<uuid>

PATCH /v2/inquiries/:id Parameter

Body

application/json

PATCH /v2/inquiries/:id Request body

resolutionType
string | null
Maximum string length: 20
response
string | null
status
enum<string>
Available options:
new,
pending_resolution,
unresolved,
resolved,
appointment_scheduled
notes
string | null

Response

PATCH /v2/inquiries/:id Positive response

id
string<uuid>
required
createdAt
any
required
updatedAt
any
required
customerCampaignId
string<uuid>
required
callId
string<uuid> | null
required
inquiry
string
required
response
string | null
required
status
enum<string>
required
Available options:
new,
pending_resolution,
unresolved,
resolved,
appointment_scheduled
primaryCategory
string | null
required
Maximum string length: 50
subcategory
string | null
required
Maximum string length: 100
severity
string | null
required
Maximum string length: 20
severityTriggers
required
suggestedHandling
string | null
required
Maximum string length: 50
handlingRationale
string | null
required
reasoning
string | null
required
escalationApplied
boolean | null
required
additionalConcerns
required
resolutionType
string | null
required
Maximum string length: 20
notes
string | null
required
resolvedAt
any
required
resolvedBy
string<uuid> | null
required