HPH Integrations APIv1 · Customer Testing
Customer Testing. Available to the Customer Testing group. Production is not available. Environment and onboarding details are provided directly, never in this documentation.
AcceptSingleItemMappingForReview

Accept a candidate for review

Persist a review proposal for one candidate without approving, publishing, releasing, or activating a mapping.

POST/v1/item-mapping-requests/{operation_reference}/review-proposals

Request schema: SingleItemAcceptForReviewRequestV1
Success schema: SingleItemReviewProposalResponseV1
Documented HTTP statuses: 200, 400, 401, 403, 404, 409, 429, 503
Contract: v1-baseline.json

Authorization

Review requires its exact permission and revalidation of company, application or delegation when applicable, entitlement, candidate availability, and revisions.

Request guidance

Send the opaque candidate_token, current result_revision, and expected_mapping_revision. Never interpret or modify the token.

Parameters

NameInTypePresenceConstraintsDescription
operation_referencepathstringRequired

Request fields

FieldTypePresenceConstraints
candidate_tokenstringRequiredmaximum 64 characters
result_revisioninteger or string (int64)Requiredminimum 1; maximum 3
expected_mapping_revisioninteger or string (int64)Requiredminimum 0; maximum 9223372036854775807

Request example

No synthetic example is approved for this operation. Follow the request-field table and versioned schema.

Idempotency and recovery

Use a new idempotency key for a new review proposal. An idempotent replay returns the persisted outcome and original completion time with reused set to true.

Response guidance

The review_proposed status means only that a proposal was persisted. The mapping revision remains unchanged.

Success response

No synthetic example is approved for this operation. Use the success schema and response guidance above.