> ## Documentation Index > Fetch the complete documentation index at: https://docs.peerlogic.com/llms.txt > Use this file to discover all available pages before exploring further. # Replace conversations ## OpenAPI ````yaml /openapi/peerlogic-api.json put /api/conversations/{id}/ openapi: 3.1.0 info: title: Peerlogic API version: 1.0.0 description: >- Customer-facing API reference for accessing Peerlogic calls, insights, conversations, tasks, opportunities, subscriptions, and events. servers: - url: https://api.prod.peerlogic.com description: Production security: [] tags: - name: Authentication description: Obtain an access token for authenticated API requests. - name: Call insights description: Call records and aggregate performance insights. - name: Transcripts description: Transcripts, summaries, sentiment, pauses, and call-purpose details. - name: Aimee description: Aimee activity, configuration, and performance insights. - name: Conversations description: Conversation records, messages, and conversation actions. - name: Tasks description: Customer tasks and task workflow actions. - name: Opportunities description: Opportunities and follow-up reporting. - name: Subscriptions and events description: >- Create and manage event subscriptions, then inspect event records and analytics. For the complete webhook delivery flow, see the Webhooks and subscriptions guide. - name: Organizations and practices description: >- Discover the organizations and practices available to the authenticated account. - name: Contacts and patients description: Find contacts and patients for caller recognition and related workflows. - name: Appointments description: Retrieve appointment history and upcoming appointments for a patient. - name: Messaging description: Send practice messages, including missed-call recovery outreach. - name: Call recordings description: Retrieve recording metadata and secure audio URLs for calls. paths: /api/conversations/{id}/: parameters: - name: id in: path description: A unique value identifying this conversation. required: true schema: type: string put: tags: - Conversations summary: Replace conversations operationId: conversations_update requestBody: $ref: '#/components/requestBodies/conversations_create_voicechatData' responses: '200': description: Successful response for replace conversations. content: application/json: schema: type: object properties: action_required: title: Action required type: boolean readOnly: true caller_name: title: Caller name type: string readOnly: true current_type: title: Current type type: string enum: - static - responsive - agent readOnly: true end_time: title: End time type: string format: date-time readOnly: true nullable: true escalated_at: title: Escalated at type: string format: date-time readOnly: true nullable: true escalation_reason: title: Escalation reason type: string readOnly: true minLength: 1 escalations: type: array items: required: - notes type: object properties: id: title: Id type: string readOnly: true minLength: 1 created_at: title: Created at type: string format: date-time readOnly: true escalation_type: title: Escalation type type: string enum: - aimee_initiated - aimee_error - user_initiated - conversation_abandoned - sms_failed - insurance_not_accepted - insurance_needs_verification - prescription_refill_request - patient_messaged_resolved_conversation - user_stop_text_received - aimee_hallucinated readOnly: true notes: type: array items: type: object properties: conversation_id: title: Conversation id type: string readOnly: true created_at: title: Created at type: string format: date-time readOnly: true created_by: title: The user that is automatically assigned type: string readOnly: true nullable: true id: title: Id type: string readOnly: true minLength: 1 is_from_escalation: title: Is from escalation type: boolean readOnly: true note: title: Note type: string readOnly: true minLength: 1 note_type: title: Note type type: string enum: - system - user readOnly: true readOnly: true id: title: Id type: string readOnly: true minLength: 1 is_action_required: title: Is action required type: string readOnly: true messages: type: array items: type: object properties: conversation_id: title: Conversation id type: string readOnly: true created_by: title: Created by type: string readOnly: true direction: title: Direction type: string enum: - inbound - outbound readOnly: true id: title: Id type: string readOnly: true minLength: 1 message_time: title: Message time type: string format: date-time readOnly: true origin_type: title: Origin type type: string enum: - system_static - system_responsive - agent - user readOnly: true is_viewed: title: Is viewed type: boolean readOnly: true patient_phone_number: title: Patient phone number type: string readOnly: true minLength: 1 nullable: true system_phone_number: title: System phone number type: string readOnly: true minLength: 1 nullable: true text: title: Text type: string readOnly: true is_webchat: title: Is webchat type: boolean readOnly: true is_voicechat: title: Is voicechat type: boolean readOnly: true is_deleted: title: Is deleted type: boolean readOnly: true deleted_at: title: Deleted at type: string format: date-time readOnly: true nullable: true deleted_by: title: Deleted by type: string readOnly: true nullable: true media: title: Media type: string readOnly: true readOnly: true messages_stats: title: Messages stats type: string readOnly: true most_recent_inbound_message_time: title: Most recent inbound message time type: string format: date-time readOnly: true nullable: true most_recent_message_time: title: Most recent message time type: string format: date-time readOnly: true nullable: true notes: type: array items: type: object properties: conversation_id: title: Conversation id type: string readOnly: true created_at: title: Created at type: string format: date-time readOnly: true created_by: title: The user that is automatically assigned type: string readOnly: true nullable: true id: title: Id type: string readOnly: true minLength: 1 is_from_escalation: title: Is from escalation type: boolean readOnly: true note: title: Note type: string readOnly: true minLength: 1 note_type: title: Note type type: string enum: - system - user readOnly: true readOnly: true opportunity: type: object properties: created_at: title: Created at type: string format: date-time readOnly: true first_follow_up_call_id: title: First follow up call id type: string readOnly: true followed_up_at: title: Followed up at type: string format: date-time readOnly: true nullable: true id: title: Id type: string readOnly: true minLength: 1 is_open: title: Is open type: boolean readOnly: true modified_at: title: Modified at type: string format: date-time readOnly: true status: title: Status type: string enum: - success - failure - omitted readOnly: true nullable: true trigger_type: title: Trigger type type: string enum: - missed_call - missed_call_existing_patient - missed_call_cancellation_reschedule - missed_call_current_appointment - missed_call_non_business - missed_call_business - high_value_missed_call - connected_call - connected_call_existing_patient - connected_call_new_patient - connected_call_high_value - lost_opportunity - lost_opportunity_new_patient - lost_opportunity_existing_patient - lost_opportunity_high_value - aimee_escalation - aimee_booked - aimee_reschedule - aimee_cancellation - aimee_inbound_message - extracted_opportunity - care_task_handed_off - voip_integration_disconnect - ehr_integration_disconnect - fax_inbound_received - fax_outbound_failed readOnly: true readOnly: true originating_call: type: object properties: call_connection: title: Call connection type: string enum: - missed - connected readOnly: true call_direction: title: Call direction type: string enum: - inbound - outbound - internal readOnly: true call_start_time: title: Call start time type: string format: date-time readOnly: true id: title: Id type: string readOnly: true minLength: 1 patients: type: array items: type: object properties: address_line_1: title: Address line 1 type: string readOnly: true minLength: 1 nullable: true address_line_2: title: Address line 2 type: string readOnly: true minLength: 1 nullable: true date_of_birth: title: Date of birth type: string format: date readOnly: true nullable: true email: title: Email type: string format: email readOnly: true minLength: 1 nullable: true id: title: Id type: string readOnly: true minLength: 1 is_active: title: Is active type: boolean readOnly: true name: title: Name type: string readOnly: true minLength: 1 nullable: true name_first: title: Name first type: string readOnly: true minLength: 1 nullable: true name_last: title: Name last type: string readOnly: true minLength: 1 nullable: true name_middle: title: Name middle type: string readOnly: true minLength: 1 nullable: true phone_fax: title: Phone fax type: string readOnly: true minLength: 1 nullable: true phone_home: title: Phone home type: string readOnly: true minLength: 1 nullable: true phone_mobile: title: Phone mobile type: string readOnly: true minLength: 1 nullable: true phone_number: title: Phone number type: string readOnly: true minLength: 1 nullable: true phone_work: title: Phone work type: string readOnly: true minLength: 1 nullable: true placeholder: title: Placeholder type: string readOnly: true minLength: 1 nullable: true pms_created_at: title: Pms created at type: string format: date-time readOnly: true nullable: true zip_code: title: Zip code type: string readOnly: true minLength: 1 nullable: true readOnly: true sip_callee_extension: title: Sip callee extension type: string readOnly: true minLength: 1 sip_callee_number: title: Sip callee number type: string readOnly: true minLength: 1 sip_caller_extension: title: Sip caller extension type: string readOnly: true minLength: 1 sip_caller_number: title: Sip caller number type: string readOnly: true minLength: 1 readOnly: true origination_type: title: Origination type type: string enum: - static - responsive - agent readOnly: true patient_phone_number: title: Patient phone number type: string readOnly: true minLength: 1 nullable: true patients: type: array items: type: object properties: address_line_1: title: Address line 1 type: string readOnly: true minLength: 1 nullable: true address_line_2: title: Address line 2 type: string readOnly: true minLength: 1 nullable: true date_of_birth: title: Date of birth type: string format: date readOnly: true nullable: true email: title: Email type: string format: email readOnly: true minLength: 1 nullable: true id: title: Id type: string readOnly: true minLength: 1 is_active: title: Is active type: boolean readOnly: true name: title: Name type: string readOnly: true minLength: 1 nullable: true name_first: title: Name first type: string readOnly: true minLength: 1 nullable: true name_last: title: Name last type: string readOnly: true minLength: 1 nullable: true name_middle: title: Name middle type: string readOnly: true minLength: 1 nullable: true phone_fax: title: Phone fax type: string readOnly: true minLength: 1 nullable: true phone_home: title: Phone home type: string readOnly: true minLength: 1 nullable: true phone_mobile: title: Phone mobile type: string readOnly: true minLength: 1 nullable: true phone_number: title: Phone number type: string readOnly: true minLength: 1 nullable: true phone_work: title: Phone work type: string readOnly: true minLength: 1 nullable: true placeholder: title: Placeholder type: string readOnly: true minLength: 1 nullable: true pms_created_at: title: Pms created at type: string format: date-time readOnly: true nullable: true zip_code: title: Zip code type: string readOnly: true minLength: 1 nullable: true readOnly: true practice_id: title: Practice id type: string readOnly: true recording_url: title: Recording url type: string readOnly: true resolutions: type: array items: required: - notes type: object properties: id: title: Id type: string readOnly: true minLength: 1 created_at: title: Created at type: string format: date-time readOnly: true resolution_type: title: Resolution type type: string enum: - booked - lost - cancelled - rescheduled - confirmed - unspecified readOnly: true nullable: true appointment: type: object properties: id: title: ID type: integer readOnly: true appointment_start_at: title: Appointment start at type: string format: date-time readOnly: true appointment_end_at: title: Appointment end at type: string format: date-time readOnly: true approximate_total_amount: title: Approximate total amount type: string format: decimal readOnly: true approximate_total_currency: title: Approximate total currency type: string readOnly: true minLength: 1 confirmed_at: title: Confirmed at type: string format: date-time readOnly: true nullable: true did_patient_miss: title: Did patient miss type: boolean readOnly: true nullable: true is_active: title: Is active type: boolean readOnly: true is_new_patient: title: Is new patient type: boolean readOnly: true nullable: true note: title: Note type: string readOnly: true minLength: 1 nullable: true patient_id: title: Patient id type: string readOnly: true booked_by_patient_id: title: Booked by patient id type: string readOnly: true pms_created_at: title: Pms created at type: string format: date-time readOnly: true nullable: true practice: title: Practice type: string readOnly: true procedures: title: Procedures type: string readOnly: true nullable: true status: title: Status type: string enum: - SCHEDULED - COMPLETED - CANCELLED - DELETED - CONFIRMED readOnly: true appointment_type: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string readOnly: true minLength: 1 duration_in_minutes: title: Duration in minutes type: integer readOnly: true practice: title: Practice type: string readOnly: true descriptors: type: array items: required: - name - code type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string maxLength: 255 minLength: 1 code: title: Code type: string maxLength: 128 minLength: 1 active: title: Active type: boolean readOnly: true peerlogic_appointment_types: title: Peerlogic appointment types type: string readOnly: true mappings: title: Mappings type: string readOnly: true is_bookable_online: title: Is bookable online type: boolean readOnly: true is_disabled_in_peerlogic: title: Is disabled in peerlogic type: boolean readOnly: true effective_is_bookable_online: title: Effective is bookable online type: string readOnly: true has_availability_schedule: title: Has availability schedule type: boolean readOnly: true nullable: true readOnly: true booked_peerlogic_appointment_type: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string enum: - Consultation - Emergency - Crown - Crown Consultation - Existing Patient Cleaning and Exam - Existing Patient Cleaning - Existing Patient Exam - >- Existing Pediatric Patient Cleaning and Exam - Existing Pediatric Patient Cleaning - Existing Pediatric Patient Exam - Extraction - Extraction Consultation - Filling - Filling Consultation - Fluoride Treatment - Implant - Implant Consultation - Invisalign Consultation - New Patient Cleaning and Exam - New Patient Cleaning - New Patient Exam - New Pediatric Patient Cleaning and Exam - New Pediatric Patient Cleaning - New Pediatric Patient Exam - Orthodontic Consultation - Periodontal Consultation - Periodontal Maintenance - Prosthodontist Consultation - Root Canal Consultation - Scaling and Root Planing - TMJ/TMD Consultation - Veneer - Veneer Consultation - Whitening - Denture - Denture Consultation - Bridge - Bridge Consultation - Cosmetic Consultation - Grooming - Vaccination - Boarding - Dental - Euthanasia - Radiology - Ultrasound - Wellness Exam - New Patient - Wellness Exam - Existing Patient - Pediatric Wellness - Technician Appointment - Sick Visit - Progress Exam - Dermatology/Allergy - Behavior Consultation - Spay - Neuter - Soft Tissue Surgery - Orthopedic Surgery - Diagnostic Imaging - Diagnostic Lab - Urgent Care - Telemedicine - Avian/Exotic Exam - Equine Field Service - Senior Wellness - Senior Wellness Exam - Geriatric Exam readOnly: true display_name: title: Display name type: string readOnly: true minLength: 1 nullable: true readOnly: true patient: type: object properties: address_line_1: title: Address line 1 type: string readOnly: true minLength: 1 nullable: true address_line_2: title: Address line 2 type: string readOnly: true minLength: 1 nullable: true date_of_birth: title: Date of birth type: string format: date readOnly: true nullable: true email: title: Email type: string format: email readOnly: true minLength: 1 nullable: true id: title: Id type: string readOnly: true minLength: 1 is_active: title: Is active type: boolean readOnly: true name: title: Name type: string readOnly: true minLength: 1 nullable: true name_first: title: Name first type: string readOnly: true minLength: 1 nullable: true name_last: title: Name last type: string readOnly: true minLength: 1 nullable: true name_middle: title: Name middle type: string readOnly: true minLength: 1 nullable: true phone_fax: title: Phone fax type: string readOnly: true minLength: 1 nullable: true phone_home: title: Phone home type: string readOnly: true minLength: 1 nullable: true phone_mobile: title: Phone mobile type: string readOnly: true minLength: 1 nullable: true phone_number: title: Phone number type: string readOnly: true minLength: 1 nullable: true phone_work: title: Phone work type: string readOnly: true minLength: 1 nullable: true placeholder: title: Placeholder type: string readOnly: true minLength: 1 nullable: true pms_created_at: title: Pms created at type: string format: date-time readOnly: true nullable: true zip_code: title: Zip code type: string readOnly: true minLength: 1 nullable: true readOnly: true provider: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string readOnly: true minLength: 1 email: title: Email type: string format: email readOnly: true minLength: 1 nullable: true phone_number: title: Phone number type: string readOnly: true minLength: 1 nullable: true is_active: title: Is active type: boolean readOnly: true readOnly: true operatory: required: - name type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string maxLength: 255 minLength: 1 display_name: title: Display name type: string maxLength: 255 nullable: true readOnly: true readOnly: true resolver_type: title: Resolver type type: string enum: - aimee - agent readOnly: true notes: type: array items: type: object properties: conversation_id: title: Conversation id type: string readOnly: true created_at: title: Created at type: string format: date-time readOnly: true created_by: title: The user that is automatically assigned type: string readOnly: true nullable: true id: title: Id type: string readOnly: true minLength: 1 is_from_escalation: title: Is from escalation type: boolean readOnly: true note: title: Note type: string readOnly: true minLength: 1 note_type: title: Note type type: string enum: - system - user readOnly: true readOnly: true resolved_at: title: Resolved at type: string format: date-time readOnly: true nullable: true resolved_by: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string maxLength: 300 email: title: Email address type: string format: email maxLength: 254 responsive_outreach_escalation_type: title: Responsive outreach escalation type type: string enum: - aimee_initiated - aimee_error - user_initiated - conversation_abandoned - sms_failed - insurance_not_accepted - insurance_needs_verification - prescription_refill_request - patient_messaged_resolved_conversation - user_stop_text_received - aimee_hallucinated readOnly: true nullable: true responsive_outreach_resolution_type: title: Responsive outreach resolution type type: string enum: - booked - lost - cancelled - rescheduled - confirmed - unspecified readOnly: true nullable: true responsive_outreach_status: title: Responsive outreach status type: string enum: - working_aimee - working_agent - escalated - not_applicable - resolved_by_aimee - resolved_by_agent - closed readOnly: true start_time: title: Start time type: string format: date-time readOnly: true status: title: Status type: string enum: - open - closed readOnly: true system_phone_number: title: System phone number type: string readOnly: true minLength: 1 nullable: true is_webchat: title: Is webchat type: boolean readOnly: true is_voicechat: title: Is voicechat type: boolean readOnly: true customer_satisfaction: title: Customer satisfaction type: string readOnly: true '400': description: The request parameters or body are invalid. content: application/json: schema: $ref: '#/components/schemas/ValidationError' example: non_field_errors: - Invalid input. '401': description: Authentication is required. content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' example: detail: '''Authorization'' header is required' '403': description: >- The authenticated account does not have permission to perform this operation. content: application/json: schema: $ref: '#/components/schemas/PermissionError' example: message: No permissions assigned to permit access to this endpoint. '404': description: >- The requested resource was not found or is not accessible to the authenticated account. content: application/json: schema: $ref: '#/components/schemas/NotFoundError' example: detail: The requested resource was not found. security: - bearerAuth: [] components: requestBodies: conversations_create_voicechatData: content: application/json: schema: type: object properties: action_required: title: Action required type: boolean readOnly: true caller_name: title: Caller name type: string readOnly: true current_type: title: Current type type: string enum: - static - responsive - agent readOnly: true end_time: title: End time type: string format: date-time readOnly: true nullable: true escalated_at: title: Escalated at type: string format: date-time readOnly: true nullable: true escalation_reason: title: Escalation reason type: string readOnly: true minLength: 1 escalations: type: array items: required: - notes type: object properties: id: title: Id type: string readOnly: true minLength: 1 created_at: title: Created at type: string format: date-time readOnly: true escalation_type: title: Escalation type type: string enum: - aimee_initiated - aimee_error - user_initiated - conversation_abandoned - sms_failed - insurance_not_accepted - insurance_needs_verification - prescription_refill_request - patient_messaged_resolved_conversation - user_stop_text_received - aimee_hallucinated readOnly: true notes: type: array items: type: object properties: conversation_id: title: Conversation id type: string readOnly: true created_at: title: Created at type: string format: date-time readOnly: true created_by: title: The user that is automatically assigned type: string readOnly: true nullable: true id: title: Id type: string readOnly: true minLength: 1 is_from_escalation: title: Is from escalation type: boolean readOnly: true note: title: Note type: string readOnly: true minLength: 1 note_type: title: Note type type: string enum: - system - user readOnly: true readOnly: true id: title: Id type: string readOnly: true minLength: 1 is_action_required: title: Is action required type: string readOnly: true messages: type: array items: type: object properties: conversation_id: title: Conversation id type: string readOnly: true created_by: title: Created by type: string readOnly: true direction: title: Direction type: string enum: - inbound - outbound readOnly: true id: title: Id type: string readOnly: true minLength: 1 message_time: title: Message time type: string format: date-time readOnly: true origin_type: title: Origin type type: string enum: - system_static - system_responsive - agent - user readOnly: true is_viewed: title: Is viewed type: boolean readOnly: true patient_phone_number: title: Patient phone number type: string readOnly: true minLength: 1 nullable: true system_phone_number: title: System phone number type: string readOnly: true minLength: 1 nullable: true text: title: Text type: string readOnly: true is_webchat: title: Is webchat type: boolean readOnly: true is_voicechat: title: Is voicechat type: boolean readOnly: true is_deleted: title: Is deleted type: boolean readOnly: true deleted_at: title: Deleted at type: string format: date-time readOnly: true nullable: true deleted_by: title: Deleted by type: string readOnly: true nullable: true media: title: Media type: string readOnly: true readOnly: true messages_stats: title: Messages stats type: string readOnly: true most_recent_inbound_message_time: title: Most recent inbound message time type: string format: date-time readOnly: true nullable: true most_recent_message_time: title: Most recent message time type: string format: date-time readOnly: true nullable: true notes: type: array items: type: object properties: conversation_id: title: Conversation id type: string readOnly: true created_at: title: Created at type: string format: date-time readOnly: true created_by: title: The user that is automatically assigned type: string readOnly: true nullable: true id: title: Id type: string readOnly: true minLength: 1 is_from_escalation: title: Is from escalation type: boolean readOnly: true note: title: Note type: string readOnly: true minLength: 1 note_type: title: Note type type: string enum: - system - user readOnly: true readOnly: true opportunity: type: object properties: created_at: title: Created at type: string format: date-time readOnly: true first_follow_up_call_id: title: First follow up call id type: string readOnly: true followed_up_at: title: Followed up at type: string format: date-time readOnly: true nullable: true id: title: Id type: string readOnly: true minLength: 1 is_open: title: Is open type: boolean readOnly: true modified_at: title: Modified at type: string format: date-time readOnly: true status: title: Status type: string enum: - success - failure - omitted readOnly: true nullable: true trigger_type: title: Trigger type type: string enum: - missed_call - missed_call_existing_patient - missed_call_cancellation_reschedule - missed_call_current_appointment - missed_call_non_business - missed_call_business - high_value_missed_call - connected_call - connected_call_existing_patient - connected_call_new_patient - connected_call_high_value - lost_opportunity - lost_opportunity_new_patient - lost_opportunity_existing_patient - lost_opportunity_high_value - aimee_escalation - aimee_booked - aimee_reschedule - aimee_cancellation - aimee_inbound_message - extracted_opportunity - care_task_handed_off - voip_integration_disconnect - ehr_integration_disconnect - fax_inbound_received - fax_outbound_failed readOnly: true readOnly: true originating_call: type: object properties: call_connection: title: Call connection type: string enum: - missed - connected readOnly: true call_direction: title: Call direction type: string enum: - inbound - outbound - internal readOnly: true call_start_time: title: Call start time type: string format: date-time readOnly: true id: title: Id type: string readOnly: true minLength: 1 patients: type: array items: type: object properties: address_line_1: title: Address line 1 type: string readOnly: true minLength: 1 nullable: true address_line_2: title: Address line 2 type: string readOnly: true minLength: 1 nullable: true date_of_birth: title: Date of birth type: string format: date readOnly: true nullable: true email: title: Email type: string format: email readOnly: true minLength: 1 nullable: true id: title: Id type: string readOnly: true minLength: 1 is_active: title: Is active type: boolean readOnly: true name: title: Name type: string readOnly: true minLength: 1 nullable: true name_first: title: Name first type: string readOnly: true minLength: 1 nullable: true name_last: title: Name last type: string readOnly: true minLength: 1 nullable: true name_middle: title: Name middle type: string readOnly: true minLength: 1 nullable: true phone_fax: title: Phone fax type: string readOnly: true minLength: 1 nullable: true phone_home: title: Phone home type: string readOnly: true minLength: 1 nullable: true phone_mobile: title: Phone mobile type: string readOnly: true minLength: 1 nullable: true phone_number: title: Phone number type: string readOnly: true minLength: 1 nullable: true phone_work: title: Phone work type: string readOnly: true minLength: 1 nullable: true placeholder: title: Placeholder type: string readOnly: true minLength: 1 nullable: true pms_created_at: title: Pms created at type: string format: date-time readOnly: true nullable: true zip_code: title: Zip code type: string readOnly: true minLength: 1 nullable: true readOnly: true sip_callee_extension: title: Sip callee extension type: string readOnly: true minLength: 1 sip_callee_number: title: Sip callee number type: string readOnly: true minLength: 1 sip_caller_extension: title: Sip caller extension type: string readOnly: true minLength: 1 sip_caller_number: title: Sip caller number type: string readOnly: true minLength: 1 readOnly: true origination_type: title: Origination type type: string enum: - static - responsive - agent readOnly: true patient_phone_number: title: Patient phone number type: string readOnly: true minLength: 1 nullable: true patients: type: array items: type: object properties: address_line_1: title: Address line 1 type: string readOnly: true minLength: 1 nullable: true address_line_2: title: Address line 2 type: string readOnly: true minLength: 1 nullable: true date_of_birth: title: Date of birth type: string format: date readOnly: true nullable: true email: title: Email type: string format: email readOnly: true minLength: 1 nullable: true id: title: Id type: string readOnly: true minLength: 1 is_active: title: Is active type: boolean readOnly: true name: title: Name type: string readOnly: true minLength: 1 nullable: true name_first: title: Name first type: string readOnly: true minLength: 1 nullable: true name_last: title: Name last type: string readOnly: true minLength: 1 nullable: true name_middle: title: Name middle type: string readOnly: true minLength: 1 nullable: true phone_fax: title: Phone fax type: string readOnly: true minLength: 1 nullable: true phone_home: title: Phone home type: string readOnly: true minLength: 1 nullable: true phone_mobile: title: Phone mobile type: string readOnly: true minLength: 1 nullable: true phone_number: title: Phone number type: string readOnly: true minLength: 1 nullable: true phone_work: title: Phone work type: string readOnly: true minLength: 1 nullable: true placeholder: title: Placeholder type: string readOnly: true minLength: 1 nullable: true pms_created_at: title: Pms created at type: string format: date-time readOnly: true nullable: true zip_code: title: Zip code type: string readOnly: true minLength: 1 nullable: true readOnly: true practice_id: title: Practice id type: string readOnly: true recording_url: title: Recording url type: string readOnly: true resolutions: type: array items: required: - notes type: object properties: id: title: Id type: string readOnly: true minLength: 1 created_at: title: Created at type: string format: date-time readOnly: true resolution_type: title: Resolution type type: string enum: - booked - lost - cancelled - rescheduled - confirmed - unspecified readOnly: true nullable: true appointment: type: object properties: id: title: ID type: integer readOnly: true appointment_start_at: title: Appointment start at type: string format: date-time readOnly: true appointment_end_at: title: Appointment end at type: string format: date-time readOnly: true approximate_total_amount: title: Approximate total amount type: string format: decimal readOnly: true approximate_total_currency: title: Approximate total currency type: string readOnly: true minLength: 1 confirmed_at: title: Confirmed at type: string format: date-time readOnly: true nullable: true did_patient_miss: title: Did patient miss type: boolean readOnly: true nullable: true is_active: title: Is active type: boolean readOnly: true is_new_patient: title: Is new patient type: boolean readOnly: true nullable: true note: title: Note type: string readOnly: true minLength: 1 nullable: true patient_id: title: Patient id type: string readOnly: true booked_by_patient_id: title: Booked by patient id type: string readOnly: true pms_created_at: title: Pms created at type: string format: date-time readOnly: true nullable: true practice: title: Practice type: string readOnly: true procedures: title: Procedures type: string readOnly: true nullable: true status: title: Status type: string enum: - SCHEDULED - COMPLETED - CANCELLED - DELETED - CONFIRMED readOnly: true appointment_type: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string readOnly: true minLength: 1 duration_in_minutes: title: Duration in minutes type: integer readOnly: true practice: title: Practice type: string readOnly: true descriptors: type: array items: required: - name - code type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string maxLength: 255 minLength: 1 code: title: Code type: string maxLength: 128 minLength: 1 active: title: Active type: boolean readOnly: true peerlogic_appointment_types: title: Peerlogic appointment types type: string readOnly: true mappings: title: Mappings type: string readOnly: true is_bookable_online: title: Is bookable online type: boolean readOnly: true is_disabled_in_peerlogic: title: Is disabled in peerlogic type: boolean readOnly: true effective_is_bookable_online: title: Effective is bookable online type: string readOnly: true has_availability_schedule: title: Has availability schedule type: boolean readOnly: true nullable: true readOnly: true booked_peerlogic_appointment_type: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string enum: - Consultation - Emergency - Crown - Crown Consultation - Existing Patient Cleaning and Exam - Existing Patient Cleaning - Existing Patient Exam - Existing Pediatric Patient Cleaning and Exam - Existing Pediatric Patient Cleaning - Existing Pediatric Patient Exam - Extraction - Extraction Consultation - Filling - Filling Consultation - Fluoride Treatment - Implant - Implant Consultation - Invisalign Consultation - New Patient Cleaning and Exam - New Patient Cleaning - New Patient Exam - New Pediatric Patient Cleaning and Exam - New Pediatric Patient Cleaning - New Pediatric Patient Exam - Orthodontic Consultation - Periodontal Consultation - Periodontal Maintenance - Prosthodontist Consultation - Root Canal Consultation - Scaling and Root Planing - TMJ/TMD Consultation - Veneer - Veneer Consultation - Whitening - Denture - Denture Consultation - Bridge - Bridge Consultation - Cosmetic Consultation - Grooming - Vaccination - Boarding - Dental - Euthanasia - Radiology - Ultrasound - Wellness Exam - New Patient - Wellness Exam - Existing Patient - Pediatric Wellness - Technician Appointment - Sick Visit - Progress Exam - Dermatology/Allergy - Behavior Consultation - Spay - Neuter - Soft Tissue Surgery - Orthopedic Surgery - Diagnostic Imaging - Diagnostic Lab - Urgent Care - Telemedicine - Avian/Exotic Exam - Equine Field Service - Senior Wellness - Senior Wellness Exam - Geriatric Exam readOnly: true display_name: title: Display name type: string readOnly: true minLength: 1 nullable: true readOnly: true patient: type: object properties: address_line_1: title: Address line 1 type: string readOnly: true minLength: 1 nullable: true address_line_2: title: Address line 2 type: string readOnly: true minLength: 1 nullable: true date_of_birth: title: Date of birth type: string format: date readOnly: true nullable: true email: title: Email type: string format: email readOnly: true minLength: 1 nullable: true id: title: Id type: string readOnly: true minLength: 1 is_active: title: Is active type: boolean readOnly: true name: title: Name type: string readOnly: true minLength: 1 nullable: true name_first: title: Name first type: string readOnly: true minLength: 1 nullable: true name_last: title: Name last type: string readOnly: true minLength: 1 nullable: true name_middle: title: Name middle type: string readOnly: true minLength: 1 nullable: true phone_fax: title: Phone fax type: string readOnly: true minLength: 1 nullable: true phone_home: title: Phone home type: string readOnly: true minLength: 1 nullable: true phone_mobile: title: Phone mobile type: string readOnly: true minLength: 1 nullable: true phone_number: title: Phone number type: string readOnly: true minLength: 1 nullable: true phone_work: title: Phone work type: string readOnly: true minLength: 1 nullable: true placeholder: title: Placeholder type: string readOnly: true minLength: 1 nullable: true pms_created_at: title: Pms created at type: string format: date-time readOnly: true nullable: true zip_code: title: Zip code type: string readOnly: true minLength: 1 nullable: true readOnly: true provider: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string readOnly: true minLength: 1 email: title: Email type: string format: email readOnly: true minLength: 1 nullable: true phone_number: title: Phone number type: string readOnly: true minLength: 1 nullable: true is_active: title: Is active type: boolean readOnly: true readOnly: true operatory: required: - name type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string maxLength: 255 minLength: 1 display_name: title: Display name type: string maxLength: 255 nullable: true readOnly: true readOnly: true resolver_type: title: Resolver type type: string enum: - aimee - agent readOnly: true notes: type: array items: type: object properties: conversation_id: title: Conversation id type: string readOnly: true created_at: title: Created at type: string format: date-time readOnly: true created_by: title: The user that is automatically assigned type: string readOnly: true nullable: true id: title: Id type: string readOnly: true minLength: 1 is_from_escalation: title: Is from escalation type: boolean readOnly: true note: title: Note type: string readOnly: true minLength: 1 note_type: title: Note type type: string enum: - system - user readOnly: true readOnly: true resolved_at: title: Resolved at type: string format: date-time readOnly: true nullable: true resolved_by: type: object properties: id: title: Id type: string readOnly: true minLength: 1 name: title: Name type: string maxLength: 300 email: title: Email address type: string format: email maxLength: 254 responsive_outreach_escalation_type: title: Responsive outreach escalation type type: string enum: - aimee_initiated - aimee_error - user_initiated - conversation_abandoned - sms_failed - insurance_not_accepted - insurance_needs_verification - prescription_refill_request - patient_messaged_resolved_conversation - user_stop_text_received - aimee_hallucinated readOnly: true nullable: true responsive_outreach_resolution_type: title: Responsive outreach resolution type type: string enum: - booked - lost - cancelled - rescheduled - confirmed - unspecified readOnly: true nullable: true responsive_outreach_status: title: Responsive outreach status type: string enum: - working_aimee - working_agent - escalated - not_applicable - resolved_by_aimee - resolved_by_agent - closed readOnly: true start_time: title: Start time type: string format: date-time readOnly: true status: title: Status type: string enum: - open - closed readOnly: true system_phone_number: title: System phone number type: string readOnly: true minLength: 1 nullable: true is_webchat: title: Is webchat type: boolean readOnly: true is_voicechat: title: Is voicechat type: boolean readOnly: true customer_satisfaction: title: Customer satisfaction type: string readOnly: true required: true schemas: ValidationError: title: Validation error type: object additionalProperties: true description: Validation details keyed by the invalid field or grouped under `errors`. AuthenticationError: title: Authentication error type: object additionalProperties: true required: - detail properties: detail: type: string description: Why authentication failed. PermissionError: title: Permission error type: object additionalProperties: false required: - message properties: message: type: string description: Why access was denied. NotFoundError: title: Not found error type: object additionalProperties: false required: - detail properties: detail: type: string description: Why the requested resource could not be returned. securitySchemes: bearerAuth: type: http scheme: bearer description: Bearer access token issued by Peerlogic. ```` ## Related topics - [Replace patient phone number](/peerlogic-api-reference/conversations/replace-patient-phone-number.md) - [Get conversation](/peerlogic-api-reference/conversations/get-conversation.md) - [List conversations](/peerlogic-api-reference/conversations/list-conversations.md) - [List conversation messages](/peerlogic-api-reference/conversations/list-conversation-messages.md) - [List Aimee conversations](/peerlogic-api-reference/aimee/list-aimee-conversations.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.