> ## Documentation Index
> Fetch the complete documentation index at: https://agents.docs.timepay.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Create Campaign
> Create a new campaign with configuration and customer records.
### Headers
Bearer token for authentication (e.g., `Bearer `).
### Body Parameters
The name of the campaign.
A brief description of the campaign's purpose.
The type of campaign (e.g., `emi`, `edi`, `lead`).
* `emi`
* `edi`
* `lead`
The ID of the workflow to associate with this campaign.
Start date in `YYYY-MM-DD` format.
Start time in `HH:MM` format (24-hour).
End date in `YYYY-MM-DD` format.
End time in `HH:MM` format (24-hour).
List of languages supported in this campaign (e.g., `["english", "hindi"]`).
* `hindi`
* `english`
* `bengali`
* `telugu`
* `marathi`
* `tamil`
* `gujarati`
* `kannada`
* `malayalam`
* `punjabi`
* `odia`
* `assamese`
Target region for the campaign (e.g., `north`).
* `north`
* `south`
* `east`
* `west`
* `central`
Tags for categorization (e.g., `["priority", "q1"]`).
Array of customer objects. The required fields within these objects change based on your campaign focus.
**Identifier Requirement**
Depending on your campaign type, you must provide either a `loan_id` (for Debt Collection) or a `lead_id` (for Lead Generation). Requests missing both will return a 400 Bad Request.
**Use this structure if you are managing existing loans.**
Unique identifier for the loan record.
Customer's first name as registered in the system.
Customer's last name as registered in the system.
Customer's primary contact number for payment reminders and notifications.
Total principal amount of the loan in the account currency.
Equated Monthly Installment (EMI) amount due for the current billing cycle.
Total loan tenure expressed as the number of monthly installments.
The current installment number in the repayment schedule (e.g., 5 of 12).
Due date for the current EMI payment. Format: `YYYY-MM-DD`.
Current status of the customer's EMI payment.
* `bounced` — Payment was attempted but failed (e.g., insufficient funds).
* `pending` — Payment is due but not yet initiated.
* `partial` — Customer has made a partial payment.
* `paid` — Payment has been completed by the customer.
* `received` — Payment has been completed by the customer.
Preferred language for the AI agent to use during the customer conversation (e.g., `english`, `hindi`, `tamil`).
**Use this structure for new sales or lead acquisition.**
Unique identifier for the lead record.
Customer's first name as registered in the system.
Customer's last name as registered in the system.
Customer's primary contact number for outreach and follow-ups.
Date the lead was created or captured. Format: `YYYY-MM-DD`.
Preferred language for the AI agent to use during the customer conversation (e.g., `english`, `hindi`, `tamil`).
### Response
Indicates if the creation was successful.
A confirmation message.
The unique ID of the newly created campaign.
The name the newly created campaign.
The error type or code (Error responses only).
```json 200 OK theme={null}
{
"success": true,
"message": "Campaign created successfully",
"data": {
"id": "camp_abc123",
"name": "Debt Collection Q1"
}
}
```
```json 400 Bad Request theme={null}
{
"success": false,
"error": "ValidationError",
"message": "Missing required field: workflowId"
}
```
```json 401 Unauthorized theme={null}
{
"success": false,
"error": "Unauthorized",
"message": "Missing or invalid authorization header"
}
```
```json 500 Server Error theme={null}
{
"success": false,
"error": "InternalServerError",
"message": "An unexpected error occurred"
}
```