ZOzocdoc
appointments

Create attachment for appointment

This endpoint is used to upload attachment documents related to the appointment for the provider to view. You can upload more than one attachment with the same attachment_type for the same appointment_id if needed. The provider will be able to receive all uploaded attachments.

Only documents of type jpg, png, pdf, and docx are supported. Documents must be less than 100MB. You may not upload attachments to appointments in a failed state or over 7 days after the appointment.

post/v1/appointments/{appointment_id}/attachments

Request

  • Base URL
    https://api-developer-sandbox.zocdoc.com
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://auth.zocdoc.com/oauth/token scopes: external.appointment.write
    • or OAuth 2
      Authorization code: https://auth.zocdoc.com/authorize
      Token URL: https://auth.zocdoc.com/oauth/token scopes: external.appointment.write

Path parameters

appointment_idstring required

Request body multipart/form-data

attachmentstring binary required
attachment_type'community_care_packet' | 'pcp_patient_referral' | 'patient_front_insurance_card' | 'patient_back_insurance_card' required

The type of attachment being uploaded.

  • community_care_packet: Required for VA referrals to Community Care Providers. Use when submitting referral documents required by the Department of Veterans Affairs for appointments within its extended network.
  • pcp_patient_referral: Use to support appointments booked with an approved referral from a primary care doctor.

Response

Successfully uploaded attachment

request_idstring required

Unique request identifier for tracing

Changes

No recorded changes to this operation across all 1 revision of this API.