Inquiries

Update inquiry by id

Change an inquiry, for example to update its status.

patch/v2/inquiries/{id}

Request

  • Base URL
    https://api.carecycle.ai
  • URL
    https://api.carecycle.ai/v2/inquiries/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring uuid

PATCH /v2/inquiries/:id Parameter

Request body

resolutionTypestring nullable
responsestring nullable
status'new' | 'pending_resolution' | 'unresolved' | 'resolved' | 'appointment_scheduled' | 'duplicate'
notesstring nullable

Response

PATCH /v2/inquiries/:id Positive response

idstring uuid required
createdAtstring date-time nullable required

Inquiry creation time. ISO 8601 timestamp

updatedAtstring date-time nullable required

Inquiry last update time. ISO 8601 timestamp

customerCampaignIdstring uuid required
callIdstring uuid nullable required
toolCallIdstring nullable required
duplicateOfIdstring uuid nullable required
inquirystring required
responsestring nullable required
status'new' | 'pending_resolution' | 'unresolved' | 'resolved' | 'appointment_scheduled' | 'duplicate' required
primaryCategorystring nullable required
subcategorystring nullable required
severitystring nullable required
priorityinteger nullable required
priorityRationalestring nullable required
priorityCategorystring nullable required
priorityConfidenceinteger nullable required
priorityRankinteger nullable required
suggestedHandlingstring nullable required
handlingRationalestring nullable required
reasoningstring nullable required
escalationAppliedboolean nullable required
resolutionTypestring nullable required
notesstring nullable required
resolvedAtstring date-time nullable required

Inquiry resolution time. ISO 8601 timestamp

resolvedBystring uuid nullable required
assignedTostring uuid nullable required
callbackRequestedAtstring date-time nullable required

Callback request time. ISO 8601 timestamp

callbackRequestedBystring uuid nullable required
callbackWorkflowIdstring uuid nullable required
callbackCompletedAtstring date-time nullable required

Callback completion time. ISO 8601 timestamp

callbackCallIdstring uuid nullable required
callbackDispositionstring nullable required
callbackFailureReasonstring nullable required
callbackScheduledForstring date-time nullable required

Scheduled callback time. ISO 8601 timestamp

Changes

No recorded changes to this operation across all 2 revisions of this API.