> ## 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.

# Reopen task



## OpenAPI

````yaml /openapi/peerlogic-api.json post /api/care/tasks/{id}/reopen/
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/care/tasks/{id}/reopen/:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
    post:
      tags:
        - Tasks
      summary: Reopen task
      operationId: care_tasks_reopen
      requestBody:
        $ref: '#/components/requestBodies/care_tasks_createData'
      responses:
        '201':
          description: Successful response for reopen task.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    title: Id
                    type: string
                    readOnly: true
                    minLength: 1
                  created_at:
                    title: Created at
                    type: string
                    format: date-time
                    readOnly: true
                  modified_at:
                    title: Modified at
                    type: string
                    format: date-time
                    readOnly: true
                  contact:
                    type: object
                    properties:
                      id:
                        title: Id
                        type: string
                        readOnly: true
                        minLength: 1
                      created_at:
                        title: Created at
                        type: string
                        format: date-time
                        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
                      name_preferred:
                        title: Name preferred
                        type: string
                        readOnly: true
                        minLength: 1
                        nullable: true
                      organization:
                        title: Organization
                        type: string
                        readOnly: true
                        minLength: 1
                        nullable: true
                      title:
                        title: Title
                        type: string
                        readOnly: true
                        minLength: 1
                        nullable: true
                      email:
                        title: Email
                        type: string
                        format: email
                        readOnly: true
                        minLength: 1
                        nullable: true
                      phone_numbers:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              title: Id
                              type: string
                              readOnly: true
                              minLength: 1
                            phone_number:
                              title: Phone number
                              type: string
                              readOnly: true
                              minLength: 1
                            source_type:
                              title: Source type
                              type: string
                              enum:
                                - call
                                - message
                                - patient
                                - fax
                                - import
                              readOnly: true
                            sip_caller_name:
                              title: Sip caller name
                              type: string
                              readOnly: true
                              minLength: 1
                              nullable: true
                            is_primary_contact:
                              title: Is primary contact
                              type: boolean
                              readOnly: true
                            phone_number_type:
                              title: Phone number type
                              type: string
                              enum:
                                - home
                                - work
                                - mobile
                                - fax
                                - other
                              readOnly: true
                        readOnly: true
                      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
                      address_city:
                        title: Address city
                        type: string
                        readOnly: true
                        minLength: 1
                        nullable: true
                      address_state:
                        title: Address state
                        type: string
                        readOnly: true
                        minLength: 1
                        nullable: true
                      zip_code:
                        title: Zip code
                        type: string
                        readOnly: true
                        minLength: 1
                        nullable: true
                      date_of_birth:
                        title: Date of birth
                        type: string
                        format: date
                        readOnly: true
                        nullable: true
                      gender:
                        title: Gender
                        type: string
                        enum:
                          - male
                          - female
                        readOnly: true
                        nullable: true
                      manually_edited_fields:
                        title: Manually edited fields
                        description: >-
                          List of field names manually edited by a user. These
                          fields are protected from automatic overwrites during
                          patient sync and contact import.
                        type: string
                        readOnly: true
                    readOnly: true
                  task_type:
                    title: Task type
                    type: string
                    enum:
                      - BILLING_COLLECTION
                      - BILLING_GET_PAYMENT_METHOD
                      - BILLING_INQUIRY
                      - BILLING_UPDATE_PAYMENT_METHOD
                      - CLINICAL_REVIEW
                      - CUSTOMER_SERVICE_RECOVERY
                      - INFORMATION_UPDATE
                      - INQUIRY_GENERAL
                      - INQUIRY_PRICING
                      - INQUIRY_UPCOMING_APPOINTMENT
                      - INSURANCE_AUTHORIZATION
                      - INSURANCE_CLAIM
                      - INSURANCE_VERIFICATION
                      - MEDICAL_RECORD_REQUEST
                      - PRODUCT_INQUIRY
                      - QA_REVIEW
                      - WEBCHAT_OUTREACH_PATIENT
                      - VOICECHAT_OUTREACH_PATIENT
                      - MISSED_CALL_OUTREACH_PATIENT
                      - PRESCRIPTION_REFILL
                      - REFERRAL
                      - SCHEDULING_BOOK_APPOINTMENT
                      - SCHEDULING_CANCEL_APPOINTMENT
                      - SCHEDULING_CONFIRM_APPOINTMENT
                      - SCHEDULING_RESCHEDULE_APPOINTMENT
                      - SUPERVISOR_HANDOFF
                      - URGENT_OUTREACH_PATIENT
                    readOnly: true
                  practice_id:
                    title: Practice id
                    type: string
                    readOnly: true
                  assignee_type:
                    title: Assignee type
                    type: string
                    enum:
                      - AIMEE
                      - STAFF
                    readOnly: true
                  status:
                    title: Status
                    type: string
                    enum:
                      - CREATED
                      - COMPLETED
                      - CANCELLED
                    readOnly: true
                  due_at:
                    title: Due at
                    type: string
                    format: date-time
                    readOnly: true
                    nullable: true
                  handoff_at:
                    title: Handoff at
                    type: string
                    format: date-time
                    readOnly: true
                    nullable: true
                  completed_at:
                    title: Completed at
                    type: string
                    format: date-time
                    readOnly: true
                    nullable: true
                  cancelled_at:
                    title: Cancelled at
                    type: string
                    format: date-time
                    readOnly: true
                    nullable: true
                  handoff_reason:
                    title: Handoff reason
                    type: string
                    enum:
                      - aimee_initiated
                      - error
                      - user_initiated
                    readOnly: true
                    nullable: true
                  handoff_notes:
                    title: Handoff notes
                    type: string
                    readOnly: true
                    minLength: 1
                    nullable: true
                  completed_by_type:
                    title: Completed by type
                    type: string
                    enum:
                      - AIMEE
                      - STAFF
                    readOnly: true
                    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
                  conversations:
                    type: array
                    items:
                      type: string
                    readOnly: true
                    uniqueItems: true
                  opportunities:
                    type: array
                    items:
                      type: string
                    readOnly: true
                    uniqueItems: true
                  appointments:
                    type: array
                    items:
                      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
                  task_description:
                    title: Task description
                    type: string
                    readOnly: true
                    minLength: 1
                    nullable: true
                  task_type_display:
                    title: Task type display
                    type: string
                    readOnly: true
                  handoff_reason_display:
                    title: Handoff reason display
                    type: string
                    readOnly: true
                  task_category:
                    title: Task category
                    type: string
                    readOnly: true
                  is_viewed:
                    title: Is viewed
                    type: boolean
                    readOnly: true
                  is_high_priority:
                    title: Is high priority
                    type: boolean
                    readOnly: true
                  detail:
                    title: Detail
                    type: string
                    readOnly: true
                    minLength: 1
                    nullable: true
        '400':
          description: The request parameters or body are invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
              example:
                task_type:
                  - This field is required.
        '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/AuthorizationError'
              example:
                detail: You do not have permission to perform this action.
        '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.
        '409':
          description: >-
            The requested state transition conflicts with the resource's current
            state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: >-
                  The requested state transition is not allowed from the current
                  state.
      security:
        - bearerAuth: []
components:
  requestBodies:
    care_tasks_createData:
      content:
        application/json:
          schema:
            type: object
            properties:
              id:
                title: Id
                type: string
                readOnly: true
                minLength: 1
              created_at:
                title: Created at
                type: string
                format: date-time
                readOnly: true
              modified_at:
                title: Modified at
                type: string
                format: date-time
                readOnly: true
              contact:
                type: object
                properties:
                  id:
                    title: Id
                    type: string
                    readOnly: true
                    minLength: 1
                  created_at:
                    title: Created at
                    type: string
                    format: date-time
                    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
                  name_preferred:
                    title: Name preferred
                    type: string
                    readOnly: true
                    minLength: 1
                    nullable: true
                  organization:
                    title: Organization
                    type: string
                    readOnly: true
                    minLength: 1
                    nullable: true
                  title:
                    title: Title
                    type: string
                    readOnly: true
                    minLength: 1
                    nullable: true
                  email:
                    title: Email
                    type: string
                    format: email
                    readOnly: true
                    minLength: 1
                    nullable: true
                  phone_numbers:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          title: Id
                          type: string
                          readOnly: true
                          minLength: 1
                        phone_number:
                          title: Phone number
                          type: string
                          readOnly: true
                          minLength: 1
                        source_type:
                          title: Source type
                          type: string
                          enum:
                            - call
                            - message
                            - patient
                            - fax
                            - import
                          readOnly: true
                        sip_caller_name:
                          title: Sip caller name
                          type: string
                          readOnly: true
                          minLength: 1
                          nullable: true
                        is_primary_contact:
                          title: Is primary contact
                          type: boolean
                          readOnly: true
                        phone_number_type:
                          title: Phone number type
                          type: string
                          enum:
                            - home
                            - work
                            - mobile
                            - fax
                            - other
                          readOnly: true
                    readOnly: true
                  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
                  address_city:
                    title: Address city
                    type: string
                    readOnly: true
                    minLength: 1
                    nullable: true
                  address_state:
                    title: Address state
                    type: string
                    readOnly: true
                    minLength: 1
                    nullable: true
                  zip_code:
                    title: Zip code
                    type: string
                    readOnly: true
                    minLength: 1
                    nullable: true
                  date_of_birth:
                    title: Date of birth
                    type: string
                    format: date
                    readOnly: true
                    nullable: true
                  gender:
                    title: Gender
                    type: string
                    enum:
                      - male
                      - female
                    readOnly: true
                    nullable: true
                  manually_edited_fields:
                    title: Manually edited fields
                    description: >-
                      List of field names manually edited by a user. These
                      fields are protected from automatic overwrites during
                      patient sync and contact import.
                    type: string
                    readOnly: true
                readOnly: true
              task_type:
                title: Task type
                type: string
                enum:
                  - BILLING_COLLECTION
                  - BILLING_GET_PAYMENT_METHOD
                  - BILLING_INQUIRY
                  - BILLING_UPDATE_PAYMENT_METHOD
                  - CLINICAL_REVIEW
                  - CUSTOMER_SERVICE_RECOVERY
                  - INFORMATION_UPDATE
                  - INQUIRY_GENERAL
                  - INQUIRY_PRICING
                  - INQUIRY_UPCOMING_APPOINTMENT
                  - INSURANCE_AUTHORIZATION
                  - INSURANCE_CLAIM
                  - INSURANCE_VERIFICATION
                  - MEDICAL_RECORD_REQUEST
                  - PRODUCT_INQUIRY
                  - QA_REVIEW
                  - WEBCHAT_OUTREACH_PATIENT
                  - VOICECHAT_OUTREACH_PATIENT
                  - MISSED_CALL_OUTREACH_PATIENT
                  - PRESCRIPTION_REFILL
                  - REFERRAL
                  - SCHEDULING_BOOK_APPOINTMENT
                  - SCHEDULING_CANCEL_APPOINTMENT
                  - SCHEDULING_CONFIRM_APPOINTMENT
                  - SCHEDULING_RESCHEDULE_APPOINTMENT
                  - SUPERVISOR_HANDOFF
                  - URGENT_OUTREACH_PATIENT
                readOnly: true
              practice_id:
                title: Practice id
                type: string
                readOnly: true
              assignee_type:
                title: Assignee type
                type: string
                enum:
                  - AIMEE
                  - STAFF
                readOnly: true
              status:
                title: Status
                type: string
                enum:
                  - CREATED
                  - COMPLETED
                  - CANCELLED
                readOnly: true
              due_at:
                title: Due at
                type: string
                format: date-time
                readOnly: true
                nullable: true
              handoff_at:
                title: Handoff at
                type: string
                format: date-time
                readOnly: true
                nullable: true
              completed_at:
                title: Completed at
                type: string
                format: date-time
                readOnly: true
                nullable: true
              cancelled_at:
                title: Cancelled at
                type: string
                format: date-time
                readOnly: true
                nullable: true
              handoff_reason:
                title: Handoff reason
                type: string
                enum:
                  - aimee_initiated
                  - error
                  - user_initiated
                readOnly: true
                nullable: true
              handoff_notes:
                title: Handoff notes
                type: string
                readOnly: true
                minLength: 1
                nullable: true
              completed_by_type:
                title: Completed by type
                type: string
                enum:
                  - AIMEE
                  - STAFF
                readOnly: true
                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
              conversations:
                type: array
                items:
                  type: string
                readOnly: true
                uniqueItems: true
              opportunities:
                type: array
                items:
                  type: string
                readOnly: true
                uniqueItems: true
              appointments:
                type: array
                items:
                  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
              task_description:
                title: Task description
                type: string
                readOnly: true
                minLength: 1
                nullable: true
              task_type_display:
                title: Task type display
                type: string
                readOnly: true
              handoff_reason_display:
                title: Handoff reason display
                type: string
                readOnly: true
              task_category:
                title: Task category
                type: string
                readOnly: true
              is_viewed:
                title: Is viewed
                type: boolean
                readOnly: true
              is_high_priority:
                title: Is high priority
                type: boolean
                readOnly: true
              detail:
                title: Detail
                type: string
                readOnly: true
                minLength: 1
                nullable: 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.
    AuthorizationError:
      title: Authorization error
      oneOf:
        - $ref: '#/components/schemas/PermissionError'
        - $ref: '#/components/schemas/DetailError'
    NotFoundError:
      title: Not found error
      type: object
      additionalProperties: false
      required:
        - detail
      properties:
        detail:
          type: string
          description: Why the requested resource could not be returned.
    ErrorResponse:
      title: Error response
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          type: string
          description: Why the request could not be completed.
    PermissionError:
      title: Permission error
      type: object
      additionalProperties: false
      required:
        - message
      properties:
        message:
          type: string
          description: Why access was denied.
    DetailError:
      title: Detail error
      type: object
      additionalProperties: false
      required:
        - detail
      properties:
        detail:
          type: string
          description: Why the request was rejected.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer access token issued by Peerlogic.

````

## Related topics

- [Change business hours](/peerlogic-voice/calling/change-business-hours.md)
- [Get task](/peerlogic-api-reference/tasks/get-task.md)
- [List tasks](/peerlogic-api-reference/tasks/list-tasks.md)
- [Cancel task](/peerlogic-api-reference/tasks/cancel-task.md)
- [Complete task](/peerlogic-api-reference/tasks/complete-task.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.