← Back to schema index

CreateBeneficiaryImportResource

Minimal JSON:API resource with the job ID and its initial status.

ExtendsJsonApiResourceBase

Properties

FieldTypeDescription
type*stringJSON:API resource type. Always `beneficiary_import`.
id*stringNumeric job ID expressed as a string (JSON:API format).
attributes*objectInitial job attributes returned upon creation.
status*stringInitial job status. The only possible value is `pending`.

Used in operations

  • POST /v1/beneficiaries/imports

Referenced by schemas