CreateBeneficiaryImportResponse
Response from `POST /v1/beneficiaries/imports` (HTTP 202). Returns a minimal JSON:API envelope with the job ID and its initial status (`pending`). Poll `GET /v1/beneficiaries/imports/{id}` every 2s until the status is `preview_ready` or `failed`.
Properties
| Field | Type | Description |
|---|---|---|
type * | string | JSON:API resource type. |
id * | string | Numeric job ID expressed as a string (JSON:API format). |
attributes * | object | Initial job attributes returned upon creation. |
status * | string | Initial job status. |
Variants
allOf
-
SuccessEnvelope -
object
Used in operations
POST /v1/beneficiaries/imports