Initiate Recovery

Add a new employee to an existing recovery campaign.

POST

/api/v1/recover/campaign/employee/add

Description

This API is used to add a new employee to an existing Recover Campaign, along with return address and assigned item details.

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

Parameter	Type	Required	Description
campaign_number	number	Yes	Unique identifier of the recover campaign
email	string	Yes	Employee email address
firstname	string	Yes	Employee first name
lastname	string	Yes	Employee last name
phone	string	Yes	Employee phone number
address_line_1	string	Yes	Employee address line 1
address_line_2	string	No	Secondary address line
city	string	Yes	Employee city
state	string	Conditional	Employee state or region. Required when country is not GB. Optional for United Kingdom (GB).
zip	string	Yes	Employee ZIP/postal code
country	string	Yes	Employee country code
recovery_reason	number	No	Recovery Reason for the user. 1 = Refresh, 2 = Break-Fix, 3 = Offboarding, 4 = Other
recovery_reason_note	string	No	Recovery reason note is required only if recovery_reason is 4 (Other)
items	array	Yes	1 to 5 item objects assigned to employee
items[].item	string	Yes	Name/label of the asset
items[].item_serial_no	string	No	Serial number of the asset
items[].item_asset_id	string	No	Internal asset ID
items[].item_imei	string	No	IMEI number for mobile devices
items[].custom_field_1	string	No	Custom metadata field 1
items[].custom_field_2	string	No	Custom metadata field 2
items[].is_legal_hold	number	No	Send 1 to mark device for legal hold

Field	Type	Description
success	boolean	Indicates if the request was successful
recovery_code	string	Generated recovery code
message	string	Success message

For United Kingdom addresses (country: GB), the state field is optional and may be omitted. For all other countries, state is required and must match a valid state or region name for that country.
zip is required for all countries, including GB.
Campaign names must be unique within your organization. Attempting to create a campaign with a duplicate name will result in a 409 Conflict error.
The campaign_number is automatically generated and serves as the primary identifier for all subsequent operations.
New campaigns are created with an active status by default. You can track their progress through the Campaign List and Campaign Details endpoints.
Use descriptive campaign names and descriptions to help organize and identify recovery efforts across different time periods or departments.

Get all recovery campaigns

Add employees to a campaign

Did this page help you?