# Models

## The models.CampaignEmailCounts object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.CampaignEmailCounts":{"type":"object","properties":{"blocked":{"type":"integer"},"bounced":{"type":"integer"},"canceled":{"type":"integer"},"catchAll":{"type":"integer"},"deferred":{"type":"integer"},"delivered":{"type":"integer"},"draft":{"type":"integer"},"dropped":{"type":"integer"},"errorOnSent":{"type":"integer"},"followUp":{"type":"integer"},"followUpCanceled":{"type":"integer"},"followUpDraft":{"type":"integer"},"invalid":{"type":"integer"},"pending":{"type":"integer"},"replied":{"type":"integer"},"scheduled":{"type":"integer"},"sent":{"type":"integer"},"spamReport":{"type":"integer"},"total":{"type":"integer"},"waitingForReschedule":{"type":"integer"}}}}}}
```

## The models.CampaignListItem object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.CampaignListItem":{"type":"object","properties":{"createdAt":{"type":"string"},"emoji":{"type":"string"},"flow":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"stats":{"$ref":"#/components/schemas/models.CampaignStats"},"status":{"type":"string"},"updatedAt":{"type":"string"}}},"models.CampaignStats":{"type":"object","properties":{"bouncedLeadsCount":{"type":"integer"},"contactedLeadsCount":{"type":"integer"},"emailsSentCount":{"type":"integer"},"leadsRespondedPositivelyCount":{"type":"integer"},"repliedLeadsCount":{"type":"integer"},"senderEmailsConnected":{"type":"integer"},"senderEmailsDisconnected":{"type":"integer"},"senderEmailsTotal":{"type":"integer"}}}}}}
```

## The models.CampaignSchedule object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.CampaignSchedule":{"type":"object","properties":{"cronSchedule":{"type":"string"},"daysSchedule":{"type":"array","items":{"type":"string"}},"endSchedule":{"type":"string"},"everySchedule":{"type":"integer"},"startSchedule":{"type":"string"}}}}}}
```

## The models.CampaignSettings object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.CampaignSettings":{"type":"object","properties":{"allowNonBusinessEmails":{"type":"boolean"},"ignoreOutOfOfficeReplies":{"type":"boolean"},"isEnabledCatchallValidated":{"type":"boolean"},"isEnabledEmailVerifier":{"type":"boolean"},"isEnabledIgnoreHardBouncedLeads":{"type":"boolean"},"isEnabledIgnoreLeadsWhoAlreadyResponded":{"type":"boolean"},"isEnabledLlm":{"type":"boolean"},"isEnabledSkipLeadIfAlreadyExists":{"type":"boolean"},"isEnabledStopFollowUpsForSameCompany":{"type":"boolean"},"isEnabledStopFollowUpsOnReply":{"type":"boolean"},"maximumSendingLimitPerSenderEmail":{"type":"integer"},"maximumSendingLimitPerSenderEmailVariation":{"type":"integer"}}}}}}
```

## The models.CampaignStats object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.CampaignStats":{"type":"object","properties":{"bouncedLeadsCount":{"type":"integer"},"contactedLeadsCount":{"type":"integer"},"emailsSentCount":{"type":"integer"},"leadsRespondedPositivelyCount":{"type":"integer"},"repliedLeadsCount":{"type":"integer"},"senderEmailsConnected":{"type":"integer"},"senderEmailsDisconnected":{"type":"integer"},"senderEmailsTotal":{"type":"integer"}}}}}}
```

## The models.CreateLeadsResponse object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.CreateLeadsResponse":{"type":"object","properties":{"count":{"type":"integer"},"message":{"type":"string"}}}}}}
```

## The models.CreateOrUpdateLeadsRequest object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.CreateOrUpdateLeadsRequest":{"type":"object","required":["leads"],"properties":{"campaignId":{"type":"integer"},"leads":{"type":"array","maxItems":1000,"minItems":1,"items":{"$ref":"#/components/schemas/models.LeadInput"}}}},"models.LeadInput":{"type":"object","required":["email"],"properties":{"company":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"linkedin":{"type":"string"},"phone":{"type":"string"},"title":{"type":"string"},"website":{"type":"string"}}}}}}
```

## The models.DeleteCampaignResponse object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.DeleteCampaignResponse":{"type":"object","properties":{"id":{"type":"integer"},"message":{"type":"string"}}}}}}
```

## The models.DeleteLeadResponse object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.DeleteLeadResponse":{"type":"object","properties":{"id":{"type":"integer"},"message":{"type":"string"}}}}}}
```

## The models.ErrorCampaignNotFound object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.ErrorCampaignNotFound":{"type":"object","properties":{"error":{"type":"string"}}}}}}
```

## The models.ErrorCampaignValidation object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.ErrorCampaignValidation":{"type":"object","properties":{"error":{"type":"string"}}}}}}
```

## The models.ErrorFailedToCreateLeads object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.ErrorFailedToCreateLeads":{"type":"object","properties":{"error":{"type":"string"}}}}}}
```

## The models.ErrorFailedToDeleteCampaign object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.ErrorFailedToDeleteCampaign":{"type":"object","properties":{"error":{"type":"string"}}}}}}
```

## The models.ErrorFailedToDeleteLead object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.ErrorFailedToDeleteLead":{"type":"object","properties":{"error":{"type":"string"}}}}}}
```

## The models.ErrorFailedToLaunchCampaign object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.ErrorFailedToLaunchCampaign":{"type":"object","properties":{"error":{"type":"string"}}}}}}
```

## The models.ErrorFailedToPauseCampaign object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.ErrorFailedToPauseCampaign":{"type":"object","properties":{"error":{"type":"string"}}}}}}
```

## The models.ErrorFailedToUpdateCampaign object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.ErrorFailedToUpdateCampaign":{"type":"object","properties":{"error":{"type":"string"}}}}}}
```

## The models.ErrorFailedToUpdateLead object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.ErrorFailedToUpdateLead":{"type":"object","properties":{"error":{"type":"string"}}}}}}
```

## The models.ErrorForbidden object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.ErrorForbidden":{"type":"object","properties":{"error":{"type":"string"}}}}}}
```

## The models.ErrorInvalidCampaignID object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.ErrorInvalidCampaignID":{"type":"object","properties":{"error":{"type":"string"}}}}}}
```

## The models.ErrorInvalidLeadID object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.ErrorInvalidLeadID":{"type":"object","properties":{"error":{"type":"string"}}}}}}
```

## The models.ErrorInvalidRequest object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.ErrorInvalidRequest":{"type":"object","properties":{"error":{"type":"string"}}}}}}
```

## The models.ErrorNotFound object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.ErrorNotFound":{"type":"object","properties":{"error":{"type":"string"}}}}}}
```

## The models.ErrorResponse object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.ErrorResponse":{"type":"object","properties":{"error":{"type":"string"}}}}}}
```

## The models.ErrorUnauthorized object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.ErrorUnauthorized":{"type":"object","properties":{"error":{"type":"string"}}}}}}
```

## The models.GetCampaignResponse object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.GetCampaignResponse":{"type":"object","properties":{"createdAt":{"type":"string"},"emails":{"$ref":"#/components/schemas/models.CampaignEmailCounts"},"emoji":{"type":"string"},"flow":{"type":"string"},"id":{"type":"integer"},"launchAt":{"type":"string"},"name":{"type":"string"},"schedule":{"$ref":"#/components/schemas/models.CampaignSchedule"},"sendAt":{"type":"string"},"settings":{"$ref":"#/components/schemas/models.CampaignSettings"},"stats":{"$ref":"#/components/schemas/models.CampaignStats"},"status":{"type":"string"},"timezone":{"type":"string"},"updatedAt":{"type":"string"}}},"models.CampaignEmailCounts":{"type":"object","properties":{"blocked":{"type":"integer"},"bounced":{"type":"integer"},"canceled":{"type":"integer"},"catchAll":{"type":"integer"},"deferred":{"type":"integer"},"delivered":{"type":"integer"},"draft":{"type":"integer"},"dropped":{"type":"integer"},"errorOnSent":{"type":"integer"},"followUp":{"type":"integer"},"followUpCanceled":{"type":"integer"},"followUpDraft":{"type":"integer"},"invalid":{"type":"integer"},"pending":{"type":"integer"},"replied":{"type":"integer"},"scheduled":{"type":"integer"},"sent":{"type":"integer"},"spamReport":{"type":"integer"},"total":{"type":"integer"},"waitingForReschedule":{"type":"integer"}}},"models.CampaignSchedule":{"type":"object","properties":{"cronSchedule":{"type":"string"},"daysSchedule":{"type":"array","items":{"type":"string"}},"endSchedule":{"type":"string"},"everySchedule":{"type":"integer"},"startSchedule":{"type":"string"}}},"models.CampaignSettings":{"type":"object","properties":{"allowNonBusinessEmails":{"type":"boolean"},"ignoreOutOfOfficeReplies":{"type":"boolean"},"isEnabledCatchallValidated":{"type":"boolean"},"isEnabledEmailVerifier":{"type":"boolean"},"isEnabledIgnoreHardBouncedLeads":{"type":"boolean"},"isEnabledIgnoreLeadsWhoAlreadyResponded":{"type":"boolean"},"isEnabledLlm":{"type":"boolean"},"isEnabledSkipLeadIfAlreadyExists":{"type":"boolean"},"isEnabledStopFollowUpsForSameCompany":{"type":"boolean"},"isEnabledStopFollowUpsOnReply":{"type":"boolean"},"maximumSendingLimitPerSenderEmail":{"type":"integer"},"maximumSendingLimitPerSenderEmailVariation":{"type":"integer"}}},"models.CampaignStats":{"type":"object","properties":{"bouncedLeadsCount":{"type":"integer"},"contactedLeadsCount":{"type":"integer"},"emailsSentCount":{"type":"integer"},"leadsRespondedPositivelyCount":{"type":"integer"},"repliedLeadsCount":{"type":"integer"},"senderEmailsConnected":{"type":"integer"},"senderEmailsDisconnected":{"type":"integer"},"senderEmailsTotal":{"type":"integer"}}}}}}
```

## The models.GetLeadResponse object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.GetLeadResponse":{"type":"object","properties":{"lead":{"$ref":"#/components/schemas/models.LeadResponse"}}},"models.LeadResponse":{"type":"object","properties":{"company":{"type":"string"},"createdAt":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"id":{"type":"integer"},"lastName":{"type":"string"},"linkedin":{"type":"string"},"phone":{"type":"string"},"title":{"type":"string"},"updatedAt":{"type":"string"},"website":{"type":"string"}}}}}}
```

## The models.LaunchCampaignResponse object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.LaunchCampaignResponse":{"type":"object","properties":{"campaign":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"status":{"type":"string"}}},"message":{"type":"string"}}}}}}
```

## The models.LeadInput object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.LeadInput":{"type":"object","required":["email"],"properties":{"company":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"linkedin":{"type":"string"},"phone":{"type":"string"},"title":{"type":"string"},"website":{"type":"string"}}}}}}
```

## The models.LeadResponse object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.LeadResponse":{"type":"object","properties":{"company":{"type":"string"},"createdAt":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"id":{"type":"integer"},"lastName":{"type":"string"},"linkedin":{"type":"string"},"phone":{"type":"string"},"title":{"type":"string"},"updatedAt":{"type":"string"},"website":{"type":"string"}}}}}}
```

## The models.ListCampaignsResponse object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.ListCampaignsResponse":{"type":"object","properties":{"campaigns":{"type":"array","items":{"$ref":"#/components/schemas/models.CampaignListItem"}},"hasMore":{"type":"boolean"},"limit":{"type":"integer"},"page":{"type":"integer"},"total":{"type":"integer"}}},"models.CampaignListItem":{"type":"object","properties":{"createdAt":{"type":"string"},"emoji":{"type":"string"},"flow":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"stats":{"$ref":"#/components/schemas/models.CampaignStats"},"status":{"type":"string"},"updatedAt":{"type":"string"}}},"models.CampaignStats":{"type":"object","properties":{"bouncedLeadsCount":{"type":"integer"},"contactedLeadsCount":{"type":"integer"},"emailsSentCount":{"type":"integer"},"leadsRespondedPositivelyCount":{"type":"integer"},"repliedLeadsCount":{"type":"integer"},"senderEmailsConnected":{"type":"integer"},"senderEmailsDisconnected":{"type":"integer"},"senderEmailsTotal":{"type":"integer"}}}}}}
```

## The models.PauseCampaignResponse object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.PauseCampaignResponse":{"type":"object","properties":{"campaign":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"status":{"type":"string"}}},"message":{"type":"string"}}}}}}
```

## The models.UpdateCampaignRequest object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.UpdateCampaignRequest":{"type":"object","properties":{"allowNonBusinessEmails":{"type":"boolean"},"emoji":{"type":"string","maxLength":10,"minLength":1},"ignoreOutOfOfficeReplies":{"type":"boolean"},"isEnabledCatchallValidated":{"type":"boolean"},"isEnabledEmailVerifier":{"type":"boolean"},"isEnabledIgnoreHardBouncedLeads":{"type":"boolean"},"isEnabledIgnoreLeadsWhoAlreadyResponded":{"type":"boolean"},"isEnabledLlm":{"description":"Settings - all optional boolean flags","type":"boolean"},"isEnabledSkipLeadIfAlreadyExists":{"type":"boolean"},"isEnabledStopFollowUpsForSameCompany":{"type":"boolean"},"isEnabledStopFollowUpsOnReply":{"type":"boolean"},"maximumSendingLimitPerSenderEmail":{"type":"integer","maximum":10000,"minimum":1},"maximumSendingLimitPerSenderEmailVariation":{"type":"integer","maximum":100,"minimum":0},"name":{"type":"string","maxLength":255,"minLength":1},"timezone":{"type":"string"}}}}}}
```

## The models.UpdateCampaignResponse object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.UpdateCampaignResponse":{"type":"object","properties":{"campaign":{"type":"object","properties":{"emoji":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"}}},"message":{"type":"string"}}}}}}
```

## The models.UpdateCampaignScheduleRequest object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.UpdateCampaignScheduleRequest":{"type":"object","required":["timezone"],"properties":{"daysSchedule":{"description":"For multiple leads scheduled campaigns (flow 3) and API campaigns","type":"array","items":{"type":"string"}},"endSchedule":{"type":"string"},"everySchedule":{"type":"integer","minimum":1},"sendAt":{"description":"For single lead scheduled campaigns (flow 2)","type":"string"},"startSchedule":{"type":"string"},"timezone":{"description":"Common field for all flows","type":"string"}}}}}}
```

## The models.UpdateCampaignScheduleResponse object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.UpdateCampaignScheduleResponse":{"type":"object","properties":{"campaign":{"type":"object","properties":{"daysSchedule":{"type":"array","items":{"type":"string"}},"endSchedule":{"type":"string"},"everySchedule":{"type":"integer"},"id":{"type":"integer"},"name":{"type":"string"},"startSchedule":{"type":"string"},"timezone":{"type":"string"}}},"message":{"type":"string"}}}}}}
```

## The models.UpdateLeadRequest object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.UpdateLeadRequest":{"type":"object","properties":{"company":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"linkedin":{"type":"string"},"phone":{"type":"string"},"title":{"type":"string"},"website":{"type":"string"}}}}}}
```

## The models.UpdateLeadResponse object

```json
{"openapi":"3.1.1","info":{"title":"Emailchaser API","version":"1.0"},"components":{"schemas":{"models.UpdateLeadResponse":{"type":"object","properties":{"lead":{"$ref":"#/components/schemas/models.LeadResponse"},"message":{"type":"string"}}},"models.LeadResponse":{"type":"object","properties":{"company":{"type":"string"},"createdAt":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"id":{"type":"integer"},"lastName":{"type":"string"},"linkedin":{"type":"string"},"phone":{"type":"string"},"title":{"type":"string"},"updatedAt":{"type":"string"},"website":{"type":"string"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://run.emailchaser.com/api-reference/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
