CommitBeneficiaryImportResponse
A `202` response for `POST /v1/beneficiaries/imports/{id}/commit`: the import ID and its status once the commit has been queued (`committing`).
Properties
| Field | Type | Description |
|---|---|---|
data | object | Main response payload. Shape varies by endpoint (object, array, or JSON:API envelope with `type`, `id`, `attributes`). |
type* | string | JSON:API resource type. Always `beneficiary_import`. |
id* | string | Numeric job ID expressed as a string. |
attributes* | object | Import job data after the commit, with its transition status. |
status* | string | New status after enqueuing the commit. The only possible value is `committing`. |
meta | object | Response metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC. |
version | string | API version that processed the request. |
api_version | string | API route prefix version (e.g. `v1`). |
request_id | string | Unique request identifier (hex). |
datetime | object | Companion descriptor present in the `meta` block of every response (and in the `meta` of outgoing webhook bodies). Lets clients assert the timezone contract without re-reading the spec. |
timezone* | string | Always `UTC`: The canonical timezone for every datetime field in the body. |
format* | string | Always `ISO 8601`: Explicit `Z` suffix on every datetime. |
links | object | Pagination or related links, present only when the endpoint returns a paginated collection. |
Used in operations
POST /v1/beneficiaries/imports/{id}/commit