← Back to schema index

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

FieldTypeDescription
dataobjectMain response payload. Shape varies by endpoint (object, array, or JSON:API envelope with `type`, `id`, `attributes`).
type*stringJSON:API resource type. Always `beneficiary_import`.
id*stringNumeric job ID expressed as a string.
attributes*objectImport job data after the commit, with its transition status.
status*stringNew status after enqueuing the commit. The only possible value is `committing`.
metaobjectResponse metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC.
versionstringAPI version that processed the request.
api_versionstringAPI route prefix version (e.g. `v1`).
request_idstringUnique request identifier (hex).
datetimeobjectCompanion 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*stringAlways `UTC`: The canonical timezone for every datetime field in the body.
format*stringAlways `ISO 8601`: Explicit `Z` suffix on every datetime.
linksobjectPagination or related links, present only when the endpoint returns a paginated collection.

Used in operations

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