WIwithpersona
inquiries

Update an Inquiry

Changed on

Updates an existing Inquiry.

Note that if you use webhooks, updates to inquiries that are not in progress can result in data getting out of sync. For example, updating a completed Inquiry will not cause your Inquiry completed webhook to retrigger.

Inquiries represent a snapshot of data collected from an individual, so we generally do not recommend updating an Inquiry's data after the Inquiry has been finalized.

patch/inquiries/{inquiry-id}

Request

  • Base URL
    https://api.withpersona.com/api/v1
  • URL
    https://api.withpersona.com/api/v1/inquiries/{inquiry-id}
  • Auth
    HTTP bearer

Path parameters

inquiry-idstring required

Query parameters

includestring

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details.

fieldsobject

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details.

Headers

Key-Inflection'camel' | 'kebab' | 'snake'

Determines casing for the API response.

Idempotency-Keystring

Ensures the request is idempotent.

Persona-Version'2026-09-29' | '2025-12-08' | '2025-10-27' | '2023-01-05' | '2022-09-01' | '2021-08-18' | '2021-07-05' | '2021-02-21' | '2020-05-18'

Server API version. More info on versioning can be found here.

Request body

Response

This endpoint returns an Inquiry object and (optionally) its related objects in included.

Changes

  • 888e37af413cRevision changes
    • info

      added the optional property //// to the response with the status

  • 8dc251058f70Revision changes
    • breaking

      added subschema #16 to the / response property oneOf list for the response status