API ReferenceInquiries

Decline an Inquiry

Declines an Inquiry. Note that this action will trigger any associated workflows and webhooks. Declining an inquiry will prevent further progress on the inquiry.

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.
metaobjectOptional

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