Initiate Recovery Campaign
Create a new recovery campaign for asset recovery operations.
POST
/api/v1/recover/campaign/createDescription
The Initiate Recovery Campaign API enables you to create a new recovery campaign. Once created, you can add employees and track asset recovery progress. A unique campaign number is generated for reference.
Request
Headers
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer <token> | Yes |
| Content-Type | application/json | Yes |
Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| campaign_name | string | Yes | Name of the recovery campaign |
| description | string | No | Optional description of the campaign |
Response
Response Fields
| Field | Type | Description |
|---|---|---|
| success | boolean | Indicates if the request was successful |
| message | string | Status message about the campaign creation |
| campaign | object | Campaign information object |
| campaign.campaign_number | number | Unique identifier for the campaign |
| campaign.campaign_name | string | Name of the campaign |
| campaign.campaign_status | string | Current status of the campaign (e.g., active, completed) |
| campaign.created_at | string | ISO 8601 timestamp of campaign creation |
| campaign.description | string | Campaign description (if provided) |
Error Responses
Common error responses you may encounter when using this endpoint.
Notes
- 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.
Related Endpoints
Did this page help you?
Request
curl -X POST https://dev-api.unduit.com/api/v1/recover/campaign/create \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"campaign_name": "Q4 2025 Asset Recovery",
"description": "Recovery campaign for Q4 2025"
}'Success Response (200)
{
"success": true,
"message": "Campaign created successfully",
"campaign": {
"campaign_number": 6720250912001,
"campaign_name": "Q4 2025 Asset Recovery",
"campaign_status": "active",
"created_at": "2025-09-12T10:30:00Z",
"description": "Recovery campaign for Q4 2025"
}
}Error Responses
400 Bad Request
{
"success": false,
"message": "Campaign name is required"
}401 Unauthorized
{
"message": "Invalid or expired token"
}409 Conflict
{
"success": false,
"message": "Campaign with this name already exists"
}