Update an external booking

PATCH 
https://partner-api-staging.solvhealth.com/v1/partner/external_bookings/:external_booking_id

Updates the status of a booking to one of the available booking status types listed in the booking status section of this document. The external booking ID is the reference from the external system integrated with Solv (typically an EHR/EMR), created at a specified external location.

Token scope:

{'scope': 'write:bookings'}

Request

Path Parameters

external_booking_id External Booking Idrequired

he unique identifier of the external booking to be updated.

application/json

Body

required

external_location_id External Location Id (string)required

The identifier of the external location.

service_id Service Id (string)required

The identifier of the service integration. Must be one of: 7, 8, or 11.

status Status (string)required

The new status to set for the booking. Must be one of the valid BookingStatus values.

Responses

200

Successful Response

application/json

Schema

Schema

address_city Address City (string)
address_state Address State (string)
address_street Address Street (string)
address_street_secondary Address Street Secondary (string)
address_zip Address Zip (string)
appointment_date Appointment Date (string)required
birth_date Birth Date (string)required
birth_sex Birth Sex (string)
custom_booking_management_url Custom Booking Management Url (string)
email Email (string)required
emr_booking_id Emr Booking Id (string)
first_name First Name (string)required
gender Gender (string)
id Id (integer)required
is_walk_in Is Walk In (boolean)required
last_name Last Name (string)required
location_id Location Id (integer)required
paperwork_status Paperwork Status (string)required
phone Phone (string)required
reason Reason (string)required
status Status (string)required

Example (from schema)

{
  "address_city": "string",
  "address_state": "string",
  "address_street": "string",
  "address_street_secondary": "string",
  "address_zip": "string",
  "appointment_date": "string",
  "birth_date": "string",
  "birth_sex": "string",
  "custom_booking_management_url": "string",
  "email": "string",
  "emr_booking_id": "string",
  "first_name": "string",
  "gender": "string",
  "id": 0,
  "is_walk_in": true,
  "last_name": "string",
  "location_id": 0,
  "paperwork_status": "string",
  "phone": "string",
  "reason": "string",
  "status": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X PATCH 'https://partner-api-staging.solvhealth.com/v1/partner/external_bookings/:external_booking_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-api-key: <API_KEY_VALUE>' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "external_location_id": "string",
  "service_id": "string",
  "status": "string"
}'

Request Collapse all

Base URL

https://partner-api-staging.solvhealth.com

Auth

APIKeyHeader

Bearer Token

Parameters

external_booking_id — pathrequired

Body required

{
  "external_location_id": "string",
  "service_id": "string",
  "status": "string"
}

ResponseClear

Click the Send API Request button above and see the response here!