Bulk Invite Beneficiary Via Email
This API is used to send invitations to multiple users . The client submits an array of invitation objects, and each invitation is processed asynchronously. Upon submission, the API responds with a job_id that can be used to track the progress and status of the batch operation.
POST /payments/beneficiaries/bulkimport/invite
Body Parameters Request
items
array
Yes
List of user objects to be invited.
items[].firstName
string
Yes
First name of the beneficiary.
items[].middleName
string
No
Middle name of the beneficiary.
items[].lastName
string
Yes
Last name of the beneficiary.
items[].email
string
Yes
Email address of the user to be invited.
items[].beneficiaryId
string
No
Optional existing beneficiary ID if already created.
items[].payGroupId
string
No
Optional payment group ID the user should belong to.
items[].invoiceCurrency
string
No
currency code (e.g., "USD", "EUR").
items[].user_tags
object
No
Optional custom tags for metadata.
Body Parameters Response
job_id
string
Unique ID assigned to the batch invitation job
demo-job-001
status
string
Current status of the job (QUEUED, PROCESSING, DONE)
DONE
total
integer
Total number of invitations in the batch
2
processed
integer
Number of invitations successfully processed
2
failed
integer
Number of invitations that failed during processing
0
processing
integer
Number of invitations currently being processed
0
started_at
string (ISO)
Timestamp when job processing started
2025-07-02T21:51:09.437368808Z
completed_at
string (ISO)
Timestamp when job processing completed
2025-07-02T21:51:09.437375388Z
progress
array
Per-row status of each invitation in the batch
[{"__row": 0, "status": "SUCCESS"}]
progress[].__row
integer
Index of the invitation in the submitted array
0
progress[].status
string
Status of the individual invitation (SUCCESS, FAILED)
SUCCESS
Request Example
Response Examples
Last updated