V1MePassportRecordsIdActions
Correct, hide or restore your private saved record
Hide is reversible presentation state, not erasure. Corrections append a replacement and retain original provenance/history. Reuse the exact operationId and payload on uncertain retry; expectedVersion rejects stale changes. A successful retry acknowledges the original operation and returns the latest record state, which may include later actions. Hidden records do not contribute to current Passport or meal summaries.
Authorization
bearer AuthorizationBearer <token>
In: header
Path Parameters
id*string
Match
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/me/passport/records/497f6eca-6276-4993-bfeb-53cbbbba6f08/actions" \ -H "Content-Type: application/json" \ -d '{ "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969", "expectedVersion": 0, "kind": "hide" }'{ "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969", "record": { "recordId": "0470cfd4-dcf3-4d8c-ac28-58c6deeff25f", "entryId": "09a8b554-45ca-4bab-a638-265db4b3e828", "version": 0, "hidden": true, "canEdit": true, "readings": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "entryId": "09a8b554-45ca-4bab-a638-265db4b3e828", "code": "8480-6", "valueNum": 0, "valueText": "string", "unit": "string", "effectiveAt": "2019-08-24T14:15:22Z", "recordedAt": "2019-08-24T14:15:22Z", "source": "healthkit", "confidence": 0, "supersedesId": "688cf67a-2e6c-4e49-8750-5bc8809fcd6f" } ], "meal": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "note": "string", "totalKcal": 0, "items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "grams": 0, "kcal": 0, "source": "search", "confidence": 0 } ] } }}