v1

latestOpenAPI 3.1.02026-07-261770816.7 KB

Rejection Details

Update rejection detail

Patch the rejection reason or rejection question custom field answers on a rejected application without changing its rejected_at timestamp. The {id} path parameter is the rejection detail record id, not the application id — fetch it from GET /v3/rejection_details?application_ids={application_id} first. The application must already be rejected; this endpoint cannot reject an application that is still in process. Only the keys included in the request body are modified; custom_fields replaces the listed rejection question values wholesale.

patch/v3/rejection_details/{id}

Path parameters

idinteger required

Request body

rejection_reason_idinteger

Id of the rejection reason to associate with the application. Must reference a /v3/rejection_reasons row in the same organization. Updating this value does not change the application's existing rejected_at timestamp.

Response

Successful

idinteger

created_atstring date-time

updated_atstring date-time

application_idinteger

Id of the application this rejection record belongs to. Rejection details exist only for rejected applications; there is one record per rejected application.

rejected_by_idinteger nullable

Id of the user who rejected the application. null for system-initiated rejections such as auto-rejection workflows.

rejection_note_idinteger nullable

Id of the note created on the application capturing the free-text rejection message, or null when no note was entered. The note body itself is not returned here — fetch it through /v3/notes/{id}.

rejection_reason_idinteger nullable

Id of the rejection reason selected for the application. References a /v3/rejection_reasons row scoped to the organization. null when the application was rejected without a reason.

rejected_atstring date-time nullable

Timestamp the application was rejected, in ISO 8601. null only for legacy or partially backfilled rejection records.

question_custom_fieldsobject nullable