Partner API v1

Submit appointment scheduling data for a patient

Submit appointment scheduling data for a patient.

Use this endpoint to send upcoming, previous, or procedure-related appointment details for a patient identified by MRN. The patient must already exist via a prior /contacts submission.

Authentication: This endpoint supports dual authentication methods:

  • Auth0 JWT Bearer Token: For partners using Auth0 authentication

    • Header: Authorization: Bearer <JWT_TOKEN>
    • Token must include partner_id claim
    • Token is validated for signature, expiration, issuer, and audience
  • Verification Token: For partners using legacy authentication

    • Header: verification-token: <ENCRYPTED_TOKEN>
    • Token format: partner_id:verification_token (encrypted)
    • Validated against partner credentials

Your partner account is configured for one of these methods. Please use the authentication method assigned to your account. If you attempt to use the wrong method, you will receive a 401 Unauthorized error.

Response Codes:

  • 201 Created: Successfully processed appointment data
  • 401 Unauthorized: Authentication failed or wrong authentication method used
  • 400 Bad Request: Invalid request payload
  • 500 Internal Server Error: Server error during processing
post/api/v1/appointments

Request

  • Base URL
    https://api.hippocraticai.com (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Request body

Response

Successful Response

unknown required

Changes

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