---
title: "Submit Deltas Query"
method: POST
path: "/deltas"
tags: ["Deltas"]
---

# Submit Deltas Query

`POST /deltas`

## Request

- Base URL: `https://sandbox.particlehealth.com`
- URL: `https://sandbox.particlehealth.com/deltas`
- Auth: API key in header `Authorization`

## Request body

- ApiDeltaParameters
  - `encounter_date` string: Encounter Date for the query used to get SureScripts data
  - `encounter_type` string: Encounter Type for the query used to get SureScripts data
  - `hints` string[]: Postal codes hinting at the believed location of records.
  - `particle_patient_id` string, required: The particle patient id that corresponds to the patient that the query is meant to be run against.
  - `purpose_of_use` string, required: The purpose of use for which this request is being made.
  - `specialties` string[]: The list of specialty searches requested for this patient

## Response `200`

OK

- ApiDeltaQueryResponse
  - `external_patient_id` string, required: The external patient id of the patient.
  - `hints` string[]: Postal codes hinting at the believed location of records.
  - `particle_patient_id` string, required: The particle patient id that corresponds to the patient that the query is meant to be run against.
  - `purpose_of_use` string, required: The purpose of use for which this request is being made.
  - `query_id` string, required: The unique ID of the query that was initiated.
  - `specialties` string[]: The list of specialty searches requested for this patient

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `429`: Too Many Requests
- `500`: Internal Server Error

## Changes

- **2026-11-03** `b59a5413a488`: 4 info
  - added the optional property `error_code` to the response with the `400` status
  - added the optional property `error_code` to the response with the `401` status
  - added the optional property `error_code` to the response with the `429` status
  - added the optional property `error_code` to the response with the `500` status

[Operation history](https://skmtc.dev/particlehealth/apis/particle-health-api/changes/deltas/post.md)

---

[API](https://skmtc.dev/particlehealth/apis/particle-health-api.md) - [All operations](https://skmtc.dev/particlehealth/apis/particle-health-api/llms.txt) - [OpenAPI document](https://skmtc.dev/particlehealth/apis/particle-health-api/revisions/b59a5413a488?raw)