API ReferenceInquiries

Update an Inquiry

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.

Path parameters

inquiry-idstringRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Key-InflectionenumOptional
Determines casing for the API response
Allowed values:
Idempotency-KeystringOptional
Ensures the request is idempotent
Persona-VersionenumOptionalDefaults to 2023-01-05
Allowed values:

Query parameters

includestringOptional

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.

fieldsmap from strings to stringsOptional

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.

Request

This endpoint expects an object.
dataobjectOptional

Response

OK
dataobject or null
An Inquiry object
includedlist of objects or null

Objects that may be returned if specified via the include query parameter in the request.

Errors