← Back to schema index

CommitBeneficiaryImportResponse

Response from `POST /v1/beneficiaries/imports/{id}/commit` (HTTP 202). Minimal JSON:API envelope with the job ID and its new status (`committing`). The worker executes the commit; poll `GET /v1/beneficiaries/imports/{id}` until `completed` or `failed`.

Properties

Field Type Description
type * string JSON:API resource type.
id * string Numeric job ID expressed as a string.
attributes * object Job attributes returned after commit (transition status).
status * string New status after enqueuing the commit.

Variants

allOf

Used in operations

  • POST /v1/beneficiaries/imports/{id}/commit