Remote Asset Recovery - Bulk Upload

Add multiple employees to a recovery campaign in one request.

POST

/api/v1/recover/campaign/employee/bulk-add

Description

The Bulk Upload API enables customers to add multiple employees (up to 100) to a recovery campaign in one request. This simplifies large-scale data entry by accepting employee objects under a single campaign. A successful upload returns unique recovery codes for each entry.

Request

Headers

Header	Value	Required
Authorization	Bearer <token>	Yes
Content-Type	application/json	Yes

Body Parameters

Parameter	Type	Required	Description
campaign_number	number	Yes	Unique identifier of the recovery campaign
users	array	Yes	Array of employee objects (1-100 employees recommended)
users[].email	string	Yes	Employee email address
users[].firstname	string	Yes	Employee first name
users[].lastname	string	Yes	Employee last name
users[].phone	string	Yes	Employee phone number
users[].city	string	Yes	Employee city
users[].state	string	Yes	Employee state or region
users[].zip	string	Yes	Employee ZIP or postal code
users[].country	string	Yes	Employee country code (e.g., US, CA, UK)

Response

Response Fields

Field	Type	Description
success	boolean	Indicates if the request was successful
message	string	Status message about the bulk upload
recovery_codes	array	Array of recovery code objects for each employee
recovery_codes[].email	string	Employee email address
recovery_codes[].recovery_code	string	Unique recovery code assigned to the employee
recovery_codes[].status	string	Status of the recovery code creation (e.g., created)

Error Responses

Common error responses you may encounter when using this endpoint.

Notes

The maximum recommended batch size is 100 employees per request to ensure optimal performance and reliability.
Each employee receives a unique recovery code that can be used to track their individual recovery status.
All employee fields (email, firstname, lastname, phone, city, state, zip, country) are required for successful processing.
If any employee in the batch has validation errors, the entire request may fail. Ensure all data is properly formatted before submission.
Recovery codes are generated automatically and returned in the response for record-keeping and tracking purposes.

Related Endpoints

Initiate Recovery

Create a new recovery campaign

Campaign List

Get all recovery campaigns

Did this page help you?

Request

curl -X POST https://dev-api.unduit.com/api/v1/recover/campaign/employee/bulk-add \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "campaign_number": 6720250912001,
    "users": [
      {
        "email": "jane.doe@example.com",
        "firstname": "Jane",
        "lastname": "Doe",
        "phone": "4155550123",
        "city": "San Francisco",
        "state": "California",
        "zip": "94103",
        "country": "US"
      }
    ]
  }'

Success Response (200)

{
  "success": true,
  "message": "Employees added successfully to campaign",
  "recovery_codes": [
    {
      "email": "jane.doe@example.com",
      "recovery_code": "REC-2024-001",
      "status": "created"
    }
  ]
}

Error Responses

400 Bad Request

{
  "success": false,
  "message": "Invalid campaign_number or missing required fields"
}

401 Unauthorized

{
  "message": "Invalid or expired token"
}

404 Not Found

{
  "success": false,
  "message": "Campaign not found"
}

413 Payload Too Large

{
  "success": false,
  "message": "Exceeded maximum of 100 employees per request"
}

422 Unprocessable Entity

{
  "success": false,
  "message": "Validation failed for one or more employees"
}