Bulk transfer agents
POST {{baseUrl}}/endpoint/agents/transfer/bulk?aid=1234
Initiates the transfer of multiple agents between accounts. The following conditions apply:
The requester must possess 'write' permissions for both the 'from' and 'to' accounts involved in each transfer.
Multiple transfers may involve a mix of different source and destination accounts.
For each transfer request, the 'from' account must match the current account of the respective agent.
Transfers are executed asynchronously.
Progress tracking is not intended, but users can monitor the progress by periodically polling the 'get agent' endpoint.
Each transfer request is individually validated and completed; this operation is not atomic, meaning transfers can succeed or fail individually.
The API response provides the status of each transfer request.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
aid | number | A unique identifier associated with your account group. You can retrieve your AccountGroupId from the /account-groups endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. |
Request Body
{"transfers"=>[{"agentId"=>"5d0764ac-7e42-4ec8-a0d4-39fc53edccba", "fromAid"=>"1234", "toAid"=>"12345"}, {"agentId"=>"5d0764ac-7e42-4ec8-a0d4-39fc53edccba", "fromAid"=>"1234", "toAid"=>"12345"}]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |