Skip to main content
POST
Queue photo files for import

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

type
enum<string>
required

Required path value identifying which record type the files should attach to. Accepted values are entity for recipients and donor for donor records; invalid values return 422.

Available options:
entity,
donor
program_id
integer
required

Required program ID used by the queued import job to scope recipient or donor matching for the current client.

Body

multipart/form-data
unique_field
string
required

Required string. Field key used to match each uploaded file to a recipient or donor.

Example:

"hys_id"

is_profile_photo
enum<string>
required

Required boolean-like value. Controls whether imported images should become profile photos.

Available options:
true,
false,
0,
1
Example:

"true"

files
file[]
required

Required uploaded image file or files. The helper accepts jpg, jpeg, png, and gif within the configured photo import size limit.

Response

Photo import jobs queued.

message
string
Example:

"File import jobs have been queued. You will be notified when the imports are complete."