> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Doppler Marketing Automation API reference

> API reference for Doppler Marketing Automation: every `dopplermarketingautomation.api.*` operation with input and output types.

> [!NOTE]
>
> **New to Corsair?** See [API access](https://docs.corsair.dev/concepts/api.md), [authentication](https://docs.corsair.dev/concepts/auth.md), and [error handling](https://docs.corsair.dev/concepts/error-handling).

## Automations

### deliverabilityRate

`automations.deliverabilityRate`

List automation deliverability

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.automations.deliverabilityRate({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `scheduledTaskId` | `number` | Yes | — |
| `from` | `string` | No | — |
| `to` | `string` | No | — |
| `page` | `number` | No | — |
| `per_page` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `items` | `object[]` | Yes | — |
| `pageSize` | `number` | No | — |
| `itemsCount` | `number` | No | — |
| `currentPage` | `number` | No | — |
| `pagesCount` | `number` | No | — |
| `lastPage` | `number` | No | — |
| `_links` | `object[]` | No | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   actionId?: number | null,
>   name?: string | null,
>   subject?: string | null,
>   subscriberId?: number | null,
>   firstName?: string | null,
>   lastName?: string | null,
>   email?: string | null,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[],
>   openings?: number | null,
>   lastOpenedDate?: string | null,
>   clicks?: number | null,
>   lastClickedDate?: string | null,
>   sentDate?: string | null,
>   status?: string | null,
>   statusDetail?: string | null,
>   date?: string | null,
>   linkId?: number | null,
>   urlLink?: string | null,
>   reason?: string | null,
>   subreason?: string | null,
>   unsubDate?: string | null
> }[]
> ```

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### linksTracking

`automations.linksTracking`

List automation link tracking

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.automations.linksTracking({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `scheduledTaskId` | `number` | Yes | — |
| `from` | `string` | No | — |
| `to` | `string` | No | — |
| `page` | `number` | No | — |
| `per_page` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `items` | `object[]` | Yes | — |
| `pageSize` | `number` | No | — |
| `itemsCount` | `number` | No | — |
| `currentPage` | `number` | No | — |
| `pagesCount` | `number` | No | — |
| `lastPage` | `number` | No | — |
| `_links` | `object[]` | No | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   actionId?: number | null,
>   name?: string | null,
>   subject?: string | null,
>   subscriberId?: number | null,
>   firstName?: string | null,
>   lastName?: string | null,
>   email?: string | null,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[],
>   openings?: number | null,
>   lastOpenedDate?: string | null,
>   clicks?: number | null,
>   lastClickedDate?: string | null,
>   sentDate?: string | null,
>   status?: string | null,
>   statusDetail?: string | null,
>   date?: string | null,
>   linkId?: number | null,
>   urlLink?: string | null,
>   reason?: string | null,
>   subreason?: string | null,
>   unsubDate?: string | null
> }[]
> ```

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### list

`automations.list`

List automations

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.automations.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `page` | `number` | No | — |
| `per_page` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `items` | `object[]` | Yes | — |
| `pageSize` | `number` | No | — |
| `itemsCount` | `number` | No | — |
| `currentPage` | `number` | No | — |
| `pagesCount` | `number` | No | — |
| `lastPage` | `number` | No | — |
| `_links` | `object[]` | No | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   scheduledTaskId?: number | null,
>   status?: string | null,
>   type?: string | null,
>   name?: string | null,
>   creationDate?: string | null,
>   emailSentAmount?: number | null,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }[]
> ```

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### opensAndClicks

`automations.opensAndClicks`

List automation opens and clicks

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.automations.opensAndClicks({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `scheduledTaskId` | `number` | Yes | — |
| `from` | `string` | No | — |
| `to` | `string` | No | — |
| `page` | `number` | No | — |
| `per_page` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `items` | `object[]` | Yes | — |
| `pageSize` | `number` | No | — |
| `itemsCount` | `number` | No | — |
| `currentPage` | `number` | No | — |
| `pagesCount` | `number` | No | — |
| `lastPage` | `number` | No | — |
| `_links` | `object[]` | No | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   actionId?: number | null,
>   name?: string | null,
>   subject?: string | null,
>   subscriberId?: number | null,
>   firstName?: string | null,
>   lastName?: string | null,
>   email?: string | null,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[],
>   openings?: number | null,
>   lastOpenedDate?: string | null,
>   clicks?: number | null,
>   lastClickedDate?: string | null,
>   sentDate?: string | null,
>   status?: string | null,
>   statusDetail?: string | null,
>   date?: string | null,
>   linkId?: number | null,
>   urlLink?: string | null,
>   reason?: string | null,
>   subreason?: string | null,
>   unsubDate?: string | null
> }[]
> ```

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### summary

`automations.summary`

Get automation summary

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.automations.summary({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `scheduledTaskId` | `number` | Yes | — |
| `from` | `string` | No | — |
| `to` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `scheduledTaskId` | `number \| null` | No | — |
| `totalUnopenedMailCount` | `number \| null` | No | — |
| `totalHardBouncedMailCount` | `number \| null` | No | — |
| `totalSoftBouncedMailCount` | `number \| null` | No | — |
| `totalDistinctOpenedMailCount` | `number \| null` | No | — |
| `totalOpenedMailCount` | `number \| null` | No | — |
| `totalDeliveryCount` | `number \| null` | No | — |
| `totalSentCount` | `number \| null` | No | — |
| `totalClickCount` | `number \| null` | No | — |
| `totalUniqueClickCount` | `number \| null` | No | — |
| `totalUniqueClickPerCampaignCount` | `number \| null` | No | — |
| `totalClickThroughOpenRate` | `number \| null` | No | — |
| `totalSocialUniqueClickCount` | `number \| null` | No | — |
| `totalForwarded` | `number \| null` | No | — |
| `totalUnsubscribersCount` | `number \| null` | No | — |
| `lastClickedEmailDate` | `string \| null` | No | — |
| `lastOpenedEmailDate` | `string \| null` | No | — |
| `detail` | `object[] \| null` | No | — |
| `_links` | `object[]` | No | — |

> [accordion] detail full type
>
> ```ts theme={null}
> {
>   actionId?: number | null,
>   name?: string | null,
>   subject?: string | null,
>   unopenedMailCount?: number | null,
>   hardBouncedMailCount?: number | null,
>   softBouncedMailCount?: number | null,
>   distinctOpenedMailCount?: number | null,
>   openedMailCount?: number | null,
>   deliveryCount?: number | null,
>   sentCount?: number | null,
>   clickCount?: number | null,
>   uniqueClickCount?: number | null,
>   uniqueClickPerCampaignCount?: number | null,
>   clickThroughOpenRate?: number | null,
>   socialUniqueClickCount?: number | null,
>   forwarded?: number | null,
>   unsubscribersCount?: number | null,
>   lastClickedEmailDate?: string | null,
>   lastOpenedEmailDate?: string | null
> }[] | null
> ```

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### unsubscribeActivity

`automations.unsubscribeActivity`

List automation unsubscribe activity

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.automations.unsubscribeActivity({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `scheduledTaskId` | `number` | Yes | — |
| `from` | `string` | No | — |
| `to` | `string` | No | — |
| `page` | `number` | No | — |
| `per_page` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `items` | `object[]` | Yes | — |
| `pageSize` | `number` | No | — |
| `itemsCount` | `number` | No | — |
| `currentPage` | `number` | No | — |
| `pagesCount` | `number` | No | — |
| `lastPage` | `number` | No | — |
| `_links` | `object[]` | No | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   actionId?: number | null,
>   name?: string | null,
>   subject?: string | null,
>   subscriberId?: number | null,
>   firstName?: string | null,
>   lastName?: string | null,
>   email?: string | null,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[],
>   openings?: number | null,
>   lastOpenedDate?: string | null,
>   clicks?: number | null,
>   lastClickedDate?: string | null,
>   sentDate?: string | null,
>   status?: string | null,
>   statusDetail?: string | null,
>   date?: string | null,
>   linkId?: number | null,
>   urlLink?: string | null,
>   reason?: string | null,
>   subreason?: string | null,
>   unsubDate?: string | null
> }[]
> ```

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

## Campaigns

### approve

`campaigns.approve`

Approve a campaign

**Risk:** `write`

```ts theme={null}
await corsair.dopplermarketingautomation.api.campaigns.approve({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `campaignId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### create

`campaigns.create`

Create a campaign

**Risk:** `write`

```ts theme={null}
await corsair.dopplermarketingautomation.api.campaigns.create({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `campaign` | `object` | Yes | — |

> [accordion] campaign full type
>
> ```ts theme={null}
> {
>   campaignId?: number,
>   name: string,
>   fromName: string,
>   fromEmail: string,
>   subject: string,
>   scheduledDate?: string | null,
>   recipientsRequired?: boolean | null,
>   contentRequired?: boolean | null,
>   preheader?: string | null,
>   replyTo?: string | null,
>   textCampaign?: boolean | null,
>   status?: draft | scheduled | shipping | shipped | string,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |
| `createdResourceId` | `string` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### createShipping

`campaigns.createShipping`

Send or schedule a campaign (emails its recipients)

**Risk:** `destructive`

```ts theme={null}
await corsair.dopplermarketingautomation.api.campaigns.createShipping({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `campaignId` | `number` | Yes | — |
| `shipping` | `object` | Yes | — |

> [accordion] shipping full type
>
> ```ts theme={null}
> {
>   shippingId?: string | null,
>   type: immediate | scheduled,
>   scheduledDate?: string | null,
>   status?: waiting | processing | sending | sent | closed | string | null,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |
| `createdResourceId` | `string` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### delete

`campaigns.delete`

Delete a campaign

**Risk:** `destructive`

```ts theme={null}
await corsair.dopplermarketingautomation.api.campaigns.delete({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `campaignId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### deleteShipping

`campaigns.deleteShipping`

Cancel a scheduled campaign delivery

**Risk:** `destructive`

```ts theme={null}
await corsair.dopplermarketingautomation.api.campaigns.deleteShipping({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `campaignId` | `number` | Yes | — |
| `shippingId` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### deleteTextAlternative

`campaigns.deleteTextAlternative`

Delete campaign text alternative

**Risk:** `destructive`

```ts theme={null}
await corsair.dopplermarketingautomation.api.campaigns.deleteTextAlternative({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `campaignId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### deliveries

`campaigns.deliveries`

List campaign deliveries

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.campaigns.deliveries({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `campaignId` | `number` | Yes | — |
| `page` | `number` | No | — |
| `per_page` | `number` | No | — |
| `continuationToken` | `number` | No | — |
| `orderBy` | `subcriber \| interactionDate` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `items` | `object[]` | Yes | — |
| `pageSize` | `number` | No | — |
| `itemsCount` | `number` | No | — |
| `currentPage` | `number` | No | — |
| `pagesCount` | `number` | No | — |
| `lastPage` | `number` | No | — |
| `_links` | `object[]` | No | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   campaignId?: number,
>   campaignName?: string,
>   campaignSubject?: string,
>   subscriberEmail?: string,
>   deliveryStatus?: opened | notOpened | hardBounced | softBounced | string | null,
>   lastOpenDate?: string,
>   sentDate?: string,
>   opensCount?: number,
>   clicksCount?: number,
>   isSendingNow?: boolean,
>   campaignType?: string,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }[]
> ```

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### get

`campaigns.get`

Get a campaign

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.campaigns.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `campaignId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `campaignId` | `number` | No | — |
| `name` | `string` | Yes | — |
| `fromName` | `string` | Yes | — |
| `fromEmail` | `string` | Yes | — |
| `subject` | `string` | Yes | — |
| `scheduledDate` | `string \| null` | No | — |
| `recipientsRequired` | `boolean \| null` | No | — |
| `contentRequired` | `boolean \| null` | No | — |
| `preheader` | `string \| null` | No | — |
| `replyTo` | `string \| null` | No | — |
| `textCampaign` | `boolean \| null` | No | — |
| `status` | `draft \| scheduled \| shipping \| shipped \| string` | No | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### getContent

`campaigns.getContent`

Get campaign HTML content

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.campaigns.getContent({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `campaignId` | `number` | Yes | — |

**Output:** `string`

***

### getRecipients

`campaigns.getRecipients`

Get campaign recipients

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.campaigns.getRecipients({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `campaignId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `lists` | `object[]` | No | — |
| `segments` | `object[]` | No | — |
| `_links` | `object[]` | No | — |

> [accordion] lists full type
>
> ```ts theme={null}
> {
>   id: number,
>   name?: string | null,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }[]
> ```

> [accordion] segments full type
>
> ```ts theme={null}
> {
>   id: number,
>   name?: string | null,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }[]
> ```

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### getShipping

`campaigns.getShipping`

Get a scheduled campaign delivery

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.campaigns.getShipping({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `campaignId` | `number` | Yes | — |
| `shippingId` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `shippingId` | `string \| null` | No | — |
| `type` | `immediate \| scheduled` | Yes | — |
| `scheduledDate` | `string \| null` | No | — |
| `status` | `waiting \| processing \| sending \| sent \| closed \| string \| null` | No | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### getSocial

`campaigns.getSocial`

Get campaign social preferences

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.campaigns.getSocial({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `campaignId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `share` | `(facebook \| twitter \| googleplus \| linkedin \| pinterest \| whatsapp)[]` | Yes | — |
| `likes` | `(facebook \| googleplus)[]` | Yes | — |
| `facebookWallPost` | `boolean` | Yes | — |
| `facebookPagesPost` | `object[]` | Yes | — |
| `twitterPost` | `boolean` | Yes | — |
| `linkedInPost` | `boolean` | Yes | — |
| `rssPost` | `boolean` | Yes | — |
| `rssDescription` | `string \| null` | No | — |
| `_links` | `object[]` | No | — |

> [accordion] facebookPagesPost full type
>
> ```ts theme={null}
> {
>   pageId: string
> }[]
> ```

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### getTextAlternative

`campaigns.getTextAlternative`

Get campaign text alternative

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.campaigns.getTextAlternative({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `campaignId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `text` | `string` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### list

`campaigns.list`

List campaigns

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.campaigns.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `page` | `number` | No | — |
| `per_page` | `number` | No | — |
| `state` | `draft \| scheduled \| shipping \| shipped` | No | — |
| `scheduledDateFrom` | `string` | No | — |
| `scheduledDateTo` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `items` | `object[]` | Yes | — |
| `pageSize` | `number` | No | — |
| `itemsCount` | `number` | No | — |
| `currentPage` | `number` | No | — |
| `pagesCount` | `number` | No | — |
| `lastPage` | `number` | No | — |
| `_links` | `object[]` | No | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   campaignId?: number,
>   name: string,
>   fromName: string,
>   fromEmail: string,
>   subject: string,
>   scheduledDate?: string | null,
>   recipientsRequired?: boolean | null,
>   contentRequired?: boolean | null,
>   preheader?: string | null,
>   replyTo?: string | null,
>   textCampaign?: boolean | null,
>   status?: draft | scheduled | shipping | shipped | string,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }[]
> ```

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### preview

`campaigns.preview`

Preview campaign content

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.campaigns.preview({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `campaignId` | `number` | Yes | — |
| `Accept` | `text/html \| image/jpeg \| image/png \| image/svg+xml` | No | — |

**Output:** `string \| custom`

***

### resultsSummary

`campaigns.resultsSummary`

Get campaign results

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.campaigns.resultsSummary({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `campaignId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `totalRecipients` | `number` | No | — |
| `successFullDeliveries` | `number` | No | — |
| `timesForwarded` | `number` | No | — |
| `totalTimesOpened` | `number` | No | — |
| `lastOpenDate` | `string` | No | — |
| `uniqueClicks` | `number` | No | — |
| `uniqueOpens` | `number` | No | — |
| `totalUnopened` | `number` | No | — |
| `totalHardBounces` | `number` | No | — |
| `totalSoftBounces` | `number` | No | — |
| `totalClicks` | `number` | No | — |
| `lastClickDate` | `string` | No | — |
| `totalUnsubscribers` | `number` | No | — |
| `campaignStatus` | `draft \| scheduled \| shipping \| shipped \| string` | No | — |
| `totalShipped` | `number` | No | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### unsubscribed

`campaigns.unsubscribed`

List campaign unsubscribers

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.campaigns.unsubscribed({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `campaignId` | `number` | Yes | — |
| `page` | `number` | No | — |
| `per_page` | `number` | No | — |
| `from` | `string` | No | — |
| `to` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `items` | `object[]` | Yes | — |
| `pageSize` | `number` | No | — |
| `itemsCount` | `number` | No | — |
| `currentPage` | `number` | No | — |
| `pagesCount` | `number` | No | — |
| `lastPage` | `number` | No | — |
| `_links` | `object[]` | No | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   email: string,
>   fields?: {
>     name: string,
>     value: string,
>     predefined?: boolean,
>     private?: boolean,
>     readonly?: boolean,
>     type?: boolean | number | string | date | email | gender | country | consent | phone | permission | string,
>     permissionHTML?: string
>   }[],
>   belongsToLists?: string[],
>   listsHistory?: {
>     date?: string,
>     listId?: number,
>     status?: added | deleted | string,
>     _links?: {
>       href: string | null,
>       rel: string,
>       description?: string
>     }[]
>   }[],
>   unsubscribedDate?: string | null,
>   unsubscriptionDate?: string | null,
>   unsubscriptionType?: hardBounce | softBounce | neverOpen | abuseLink | feedbackLoop | internalPolicies | manual | string | null,
>   manualUnsubscriptionReason?: administrative | subscriberRequestNeverSubscribed | subscriberRequestNotInterestingContent | subscriberRequestIsSpam | subscriberRequestTooManyEmails | subscriberRequestOther | null,
>   unsubscriptionComment?: string | null,
>   status?: active | pending | unsubscribed | standBy | archived | string | null,
>   canBeReactivated?: boolean | null,
>   isBeingReactivated?: boolean | null,
>   userId?: number,
>   score?: number,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }[]
> ```

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### update

`campaigns.update`

Update a campaign

**Risk:** `write`

```ts theme={null}
await corsair.dopplermarketingautomation.api.campaigns.update({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `campaignId` | `number` | Yes | — |
| `campaign` | `object` | Yes | — |

> [accordion] campaign full type
>
> ```ts theme={null}
> {
>   campaignId?: number,
>   name: string,
>   fromName: string,
>   fromEmail: string,
>   subject: string,
>   scheduledDate?: string | null,
>   recipientsRequired?: boolean | null,
>   contentRequired?: boolean | null,
>   preheader?: string | null,
>   replyTo?: string | null,
>   textCampaign?: boolean | null,
>   status?: draft | scheduled | shipping | shipped | string,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### updateContent

`campaigns.updateContent`

Update campaign HTML content

**Risk:** `write`

```ts theme={null}
await corsair.dopplermarketingautomation.api.campaigns.updateContent({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `campaignId` | `number` | Yes | — |
| `Body` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### updateRecipients

`campaigns.updateRecipients`

Update campaign recipients

**Risk:** `write`

```ts theme={null}
await corsair.dopplermarketingautomation.api.campaigns.updateRecipients({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `campaignId` | `number` | Yes | — |
| `recipients` | `object` | Yes | — |

> [accordion] recipients full type
>
> ```ts theme={null}
> {
>   lists?: {
>     id: number,
>     name?: string | null,
>     _links?: {
>       href: string | null,
>       rel: string,
>       description?: string
>     }[]
>   }[],
>   segments?: {
>     id: number,
>     name?: string | null,
>     _links?: {
>       href: string | null,
>       rel: string,
>       description?: string
>     }[]
>   }[],
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### updateSocial

`campaigns.updateSocial`

Update campaign social preferences

**Risk:** `write`

```ts theme={null}
await corsair.dopplermarketingautomation.api.campaigns.updateSocial({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `campaignId` | `number` | Yes | — |
| `socialMediaPreferences` | `object` | Yes | — |

> [accordion] socialMediaPreferences full type
>
> ```ts theme={null}
> {
>   share: (facebook | twitter | googleplus | linkedin | pinterest | whatsapp)[],
>   likes: (facebook | googleplus)[],
>   facebookWallPost: boolean,
>   facebookPagesPost: {
>     pageId: string
>   }[],
>   twitterPost: boolean,
>   linkedInPost: boolean,
>   rssPost: boolean,
>   rssDescription?: string | null,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### updateTextAlternative

`campaigns.updateTextAlternative`

Update campaign text alternative

**Risk:** `write`

```ts theme={null}
await corsair.dopplermarketingautomation.api.campaigns.updateTextAlternative({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `campaignId` | `number` | Yes | — |
| `textAlternativeContent` | `object` | Yes | — |

> [accordion] textAlternativeContent full type
>
> ```ts theme={null}
> {
>   text: string,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

## Fields

### list

`fields.list`

List subscriber field definitions

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.fields.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `items` | `object[]` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   name: string,
>   predefined: boolean,
>   private: boolean,
>   readonly: boolean,
>   type: boolean | number | string | date | email | gender | country | consent | phone | permission | string,
>   sample?: string | null,
>   fieldId?: number | null,
>   permissionHTML?: string | null,
>   required?: boolean | null,
>   allowedValues?: string[] | null,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }[]
> ```

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

## Home

### account

`home.account`

Get the account API home

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.home.account({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### get

`home.get`

Get the API home

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.home.get({});
```

**Input:** *empty object*

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

## Integrations

### delete

`integrations.delete`

Delete integration access

**Risk:** `destructive`

```ts theme={null}
await corsair.dopplermarketingautomation.api.integrations.delete({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `integrationName` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### get

`integrations.get`

Get integration access

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.integrations.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `integrationName` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### update

`integrations.update`

Update integration access

**Risk:** `write`

```ts theme={null}
await corsair.dopplermarketingautomation.api.integrations.update({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `integrationName` | `string` | Yes | — |
| `thirdPartyAppAccess` | `object` | Yes | — |

> [accordion] thirdPartyAppAccess full type
>
> ```ts theme={null}
> {
>   accessToken?: string | null,
>   refreshToken?: string | null,
>   idAccount?: number | null,
>   accountName?: string | null
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

## Lists

### create

`lists.create`

Create a subscriber list

**Risk:** `write`

```ts theme={null}
await corsair.dopplermarketingautomation.api.lists.create({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `list` | `object` | Yes | — |
| `X-Doppler-List-Origin` | `string` | No | — |

> [accordion] list full type
>
> ```ts theme={null}
> {
>   name: string,
>   removeAssociation?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |
| `createdResourceId` | `string` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### delete

`lists.delete`

Delete a subscriber list

**Risk:** `destructive`

```ts theme={null}
await corsair.dopplermarketingautomation.api.lists.delete({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `listId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### get

`lists.get`

Get a subscriber list

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.lists.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `listId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `listId` | `number` | No | — |
| `name` | `string` | Yes | — |
| `currentStatus` | `ready \| draft \| readyToSent \| sent \| importingSubscribers \| exportingSubscribers \| mergingDestination \| mergingSource \| cancelingExportingSubscribers \| inCreationProcess \| sending \| inDeletingProcess \| deleted \| blocked \| string` | No | — |
| `subscribersCount` | `number` | No | — |
| `creationDate` | `string` | No | — |
| `deletedDate` | `string` | No | — |
| `hasScheduledCampaigns` | `boolean \| null` | No | — |
| `hasFormsAssociated` | `boolean \| null` | No | — |
| `hasSegmentsAssociated` | `boolean \| null` | No | — |
| `hasEventsAssociated` | `boolean \| null` | No | — |
| `hasSynchronizationAssociated` | `boolean` | No | — |
| `removeAssociation` | `boolean` | No | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### list

`lists.list`

List subscriber lists

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.lists.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `page` | `number` | No | — |
| `per_page` | `number` | No | — |
| `state` | `active \| inactive \| all` | No | — |
| `listName` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `items` | `object[]` | Yes | — |
| `pageSize` | `number` | No | — |
| `itemsCount` | `number` | No | — |
| `currentPage` | `number` | No | — |
| `pagesCount` | `number` | No | — |
| `lastPage` | `number` | No | — |
| `_links` | `object[]` | No | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   listId?: number,
>   name: string,
>   currentStatus?: ready | draft | readyToSent | sent | importingSubscribers | exportingSubscribers | mergingDestination | mergingSource | cancelingExportingSubscribers | inCreationProcess | sending | inDeletingProcess | deleted | blocked | string,
>   subscribersCount?: number,
>   creationDate?: string,
>   deletedDate?: string,
>   hasScheduledCampaigns?: boolean | null,
>   hasFormsAssociated?: boolean | null,
>   hasSegmentsAssociated?: boolean | null,
>   hasEventsAssociated?: boolean | null,
>   hasSynchronizationAssociated?: boolean,
>   removeAssociation?: boolean,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }[]
> ```

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### update

`lists.update`

Update a subscriber list

**Risk:** `write`

```ts theme={null}
await corsair.dopplermarketingautomation.api.lists.update({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `listId` | `number` | Yes | — |
| `list` | `object` | Yes | — |
| `X-Doppler-List-Origin` | `string` | No | — |

> [accordion] list full type
>
> ```ts theme={null}
> {
>   name: string,
>   removeAssociation?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

## Subscribers

### archive

`subscribers.archive`

Archive a subscriber

**Risk:** `write`

```ts theme={null}
await corsair.dopplermarketingautomation.api.subscribers.archive({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `email` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### associate

`subscribers.associate`

Associate a subscriber with a list

**Risk:** `write`

```ts theme={null}
await corsair.dopplermarketingautomation.api.subscribers.associate({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `listId` | `number` | Yes | — |
| `subscriber` | `object` | Yes | — |
| `X-Doppler-Subscriber-Origin` | `string` | No | — |
| `allowReSubscription` | `boolean` | No | — |

> [accordion] subscriber full type
>
> ```ts theme={null}
> {
>   email: string,
>   fields?: {
>     name: string,
>     value: string,
>     predefined?: boolean,
>     private?: boolean,
>     readonly?: boolean,
>     type?: boolean | number | string | date | email | gender | country | consent | phone | permission | string,
>     permissionHTML?: string
>   }[],
>   belongsToLists?: string[],
>   listsHistory?: {
>     date?: string,
>     listId?: number,
>     status?: added | deleted | string,
>     _links?: {
>       href: string | null,
>       rel: string,
>       description?: string
>     }[]
>   }[],
>   unsubscribedDate?: string | null,
>   unsubscriptionDate?: string | null,
>   unsubscriptionType?: hardBounce | softBounce | neverOpen | abuseLink | feedbackLoop | internalPolicies | manual | string | null,
>   manualUnsubscriptionReason?: administrative | subscriberRequestNeverSubscribed | subscriberRequestNotInterestingContent | subscriberRequestIsSpam | subscriberRequestTooManyEmails | subscriberRequestOther | null,
>   unsubscriptionComment?: string | null,
>   status?: active | pending | unsubscribed | standBy | archived | string | null,
>   canBeReactivated?: boolean | null,
>   isBeingReactivated?: boolean | null,
>   userId?: number,
>   score?: number,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### create

`subscribers.create`

Create or update a subscriber

**Risk:** `write`

```ts theme={null}
await corsair.dopplermarketingautomation.api.subscribers.create({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `subscriber` | `object` | Yes | — |
| `X-Doppler-Subscriber-Origin` | `string` | No | — |

> [accordion] subscriber full type
>
> ```ts theme={null}
> {
>   email: string,
>   fields?: {
>     name: string,
>     value: string,
>     predefined?: boolean,
>     private?: boolean,
>     readonly?: boolean,
>     type?: boolean | number | string | date | email | gender | country | consent | phone | permission | string,
>     permissionHTML?: string
>   }[],
>   belongsToLists?: string[],
>   listsHistory?: {
>     date?: string,
>     listId?: number,
>     status?: added | deleted | string,
>     _links?: {
>       href: string | null,
>       rel: string,
>       description?: string
>     }[]
>   }[],
>   unsubscribedDate?: string | null,
>   unsubscriptionDate?: string | null,
>   unsubscriptionType?: hardBounce | softBounce | neverOpen | abuseLink | feedbackLoop | internalPolicies | manual | string | null,
>   manualUnsubscriptionReason?: administrative | subscriberRequestNeverSubscribed | subscriberRequestNotInterestingContent | subscriberRequestIsSpam | subscriberRequestTooManyEmails | subscriberRequestOther | null,
>   unsubscriptionComment?: string | null,
>   status?: active | pending | unsubscribed | standBy | archived | string | null,
>   canBeReactivated?: boolean | null,
>   isBeingReactivated?: boolean | null,
>   userId?: number,
>   score?: number,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### deliveries

`subscribers.deliveries`

List subscriber campaign deliveries

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.subscribers.deliveries({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `email` | `string` | Yes | — |
| `page` | `number` | No | — |
| `per_page` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `items` | `object[]` | Yes | — |
| `pageSize` | `number` | No | — |
| `itemsCount` | `number` | No | — |
| `currentPage` | `number` | No | — |
| `pagesCount` | `number` | No | — |
| `lastPage` | `number` | No | — |
| `_links` | `object[]` | No | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   campaignId?: number,
>   campaignName?: string,
>   campaignSubject?: string,
>   subscriberEmail?: string,
>   deliveryStatus?: opened | notOpened | hardBounced | softBounced | string | null,
>   lastOpenDate?: string,
>   sentDate?: string,
>   opensCount?: number,
>   clicksCount?: number,
>   isSendingNow?: boolean,
>   campaignType?: string,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }[]
> ```

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### doubleOptIn

`subscribers.doubleOptIn`

Associate a subscriber using double opt-in (emails the subscriber)

**Risk:** `destructive`

```ts theme={null}
await corsair.dopplermarketingautomation.api.subscribers.doubleOptIn({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `listId` | `number` | Yes | — |
| `templateId` | `number` | Yes | — |
| `subscriber` | `object` | Yes | — |
| `X-Doppler-Subscriber-Origin` | `string` | No | — |

> [accordion] subscriber full type
>
> ```ts theme={null}
> {
>   email: string,
>   fields?: {
>     name: string,
>     value: string,
>     predefined?: boolean,
>     private?: boolean,
>     readonly?: boolean,
>     type?: boolean | number | string | date | email | gender | country | consent | phone | permission | string,
>     permissionHTML?: string
>   }[],
>   belongsToLists?: string[],
>   listsHistory?: {
>     date?: string,
>     listId?: number,
>     status?: added | deleted | string,
>     _links?: {
>       href: string | null,
>       rel: string,
>       description?: string
>     }[]
>   }[],
>   unsubscribedDate?: string | null,
>   unsubscriptionDate?: string | null,
>   unsubscriptionType?: hardBounce | softBounce | neverOpen | abuseLink | feedbackLoop | internalPolicies | manual | string | null,
>   manualUnsubscriptionReason?: administrative | subscriberRequestNeverSubscribed | subscriberRequestNotInterestingContent | subscriberRequestIsSpam | subscriberRequestTooManyEmails | subscriberRequestOther | null,
>   unsubscriptionComment?: string | null,
>   status?: active | pending | unsubscribed | standBy | archived | string | null,
>   canBeReactivated?: boolean | null,
>   isBeingReactivated?: boolean | null,
>   userId?: number,
>   score?: number,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### exists

`subscribers.exists`

Check whether a subscriber exists

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.subscribers.exists({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `email` | `string` | Yes | — |

**Output:** `boolean`

***

### get

`subscribers.get`

Get a subscriber

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.subscribers.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `email` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `email` | `string` | Yes | — |
| `fields` | `object[]` | No | — |
| `belongsToLists` | `string[]` | No | — |
| `listsHistory` | `object[]` | No | — |
| `unsubscribedDate` | `string \| null` | No | — |
| `unsubscriptionDate` | `string \| null` | No | — |
| `unsubscriptionType` | `hardBounce \| softBounce \| neverOpen \| abuseLink \| feedbackLoop \| internalPolicies \| manual \| string \| null` | No | — |
| `manualUnsubscriptionReason` | `administrative \| subscriberRequestNeverSubscribed \| subscriberRequestNotInterestingContent \| subscriberRequestIsSpam \| subscriberRequestTooManyEmails \| subscriberRequestOther \| null` | No | — |
| `unsubscriptionComment` | `string \| null` | No | — |
| `status` | `active \| pending \| unsubscribed \| standBy \| archived \| string \| null` | No | — |
| `canBeReactivated` | `boolean \| null` | No | — |
| `isBeingReactivated` | `boolean \| null` | No | — |
| `userId` | `number` | No | — |
| `score` | `number` | No | — |
| `_links` | `object[]` | No | — |

> [accordion] fields full type
>
> ```ts theme={null}
> {
>   name: string,
>   value: string,
>   predefined?: boolean,
>   private?: boolean,
>   readonly?: boolean,
>   type?: boolean | number | string | date | email | gender | country | consent | phone | permission | string,
>   permissionHTML?: string
> }[]
> ```

> [accordion] listsHistory full type
>
> ```ts theme={null}
> {
>   date?: string,
>   listId?: number,
>   status?: added | deleted | string,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }[]
> ```

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### import

`subscribers.import`

Import account subscribers

**Risk:** `write`

```ts theme={null}
await corsair.dopplermarketingautomation.api.subscribers.import({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `subscribers` | `object` | Yes | — |
| `X-Doppler-Subscriber-Origin` | `string` | No | — |

> [accordion] subscribers full type
>
> ```ts theme={null}
> {
>   items: {
>     email: string,
>     fields?: {
>       name: string,
>       value: string,
>       predefined?: boolean,
>       private?: boolean,
>       readonly?: boolean,
>       type?: boolean | number | string | date | email | gender | country | consent | phone | permission | string,
>       permissionHTML?: string
>     }[]
>   }[],
>   fields: string[],
>   callback?: string,
>   enableEmailNotification?: boolean | null
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |
| `createdResourceId` | `string` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### importCsv

`subscribers.importCsv`

Import subscribers from CSV

**Risk:** `write`

```ts theme={null}
await corsair.dopplermarketingautomation.api.subscribers.importCsv({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `listId` | `number` | Yes | — |
| `Body` | `string` | Yes | — |
| `X-Doppler-Subscriber-Origin` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |
| `createdResourceId` | `string` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### importToList

`subscribers.importToList`

Import subscribers into a list

**Risk:** `write`

```ts theme={null}
await corsair.dopplermarketingautomation.api.subscribers.importToList({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `listId` | `number` | Yes | — |
| `subscribers` | `object` | Yes | — |
| `X-Doppler-Subscriber-Origin` | `string` | No | — |

> [accordion] subscribers full type
>
> ```ts theme={null}
> {
>   items: {
>     email: string,
>     fields?: {
>       name: string,
>       value: string,
>       predefined?: boolean,
>       private?: boolean,
>       readonly?: boolean,
>       type?: boolean | number | string | date | email | gender | country | consent | phone | permission | string,
>       permissionHTML?: string
>     }[]
>   }[],
>   fields: string[],
>   callback?: string,
>   enableEmailNotification?: boolean | null
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |
| `createdResourceId` | `string` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### importUnsubscribed

`subscribers.importUnsubscribed`

Import unsubscribed subscribers

**Risk:** `destructive`

```ts theme={null}
await corsair.dopplermarketingautomation.api.subscribers.importUnsubscribed({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `subscribers` | `object` | Yes | — |

> [accordion] subscribers full type
>
> ```ts theme={null}
> {
>   items: {
>     email: string,
>     manualUnsubscriptionReason?: administrative | subscriberRequestNeverSubscribed | subscriberRequestNotInterestingContent | subscriberRequestIsSpam | subscriberRequestTooManyEmails | subscriberRequestOther | null,
>     unsubscriptionComment?: string | null
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### list

`subscribers.list`

List account subscribers

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.subscribers.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `page` | `number` | No | — |
| `per_page` | `number` | No | — |
| `keyword` | `string` | No | — |
| `updatedAfter` | `string` | No | — |
| `resumeFrom` | `number` | No | — |
| `withFieldType` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `items` | `object[]` | Yes | — |
| `pageSize` | `number` | No | — |
| `itemsCount` | `number` | No | — |
| `currentPage` | `number` | No | — |
| `pagesCount` | `number` | No | — |
| `lastPage` | `number` | No | — |
| `_links` | `object[]` | No | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   email: string,
>   fields?: {
>     name: string,
>     value: string,
>     predefined?: boolean,
>     private?: boolean,
>     readonly?: boolean,
>     type?: boolean | number | string | date | email | gender | country | consent | phone | permission | string,
>     permissionHTML?: string
>   }[],
>   belongsToLists?: string[],
>   listsHistory?: {
>     date?: string,
>     listId?: number,
>     status?: added | deleted | string,
>     _links?: {
>       href: string | null,
>       rel: string,
>       description?: string
>     }[]
>   }[],
>   unsubscribedDate?: string | null,
>   unsubscriptionDate?: string | null,
>   unsubscriptionType?: hardBounce | softBounce | neverOpen | abuseLink | feedbackLoop | internalPolicies | manual | string | null,
>   manualUnsubscriptionReason?: administrative | subscriberRequestNeverSubscribed | subscriberRequestNotInterestingContent | subscriberRequestIsSpam | subscriberRequestTooManyEmails | subscriberRequestOther | null,
>   unsubscriptionComment?: string | null,
>   status?: active | pending | unsubscribed | standBy | archived | string | null,
>   canBeReactivated?: boolean | null,
>   isBeingReactivated?: boolean | null,
>   userId?: number,
>   score?: number,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }[]
> ```

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### listByOrigin

`subscribers.listByOrigin`

List subscribers by origin

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.subscribers.listByOrigin({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `origin` | `string` | Yes | — |
| `page` | `number` | No | — |
| `per_page` | `number` | No | — |
| `updatedAfter` | `string` | No | — |
| `withFieldType` | `string` | No | — |
| `withFieldName` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `items` | `object[]` | Yes | — |
| `pageSize` | `number` | No | — |
| `itemsCount` | `number` | No | — |
| `currentPage` | `number` | No | — |
| `pagesCount` | `number` | No | — |
| `lastPage` | `number` | No | — |
| `_links` | `object[]` | No | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   email: string,
>   fields?: {
>     name: string,
>     value: string,
>     predefined?: boolean,
>     private?: boolean,
>     readonly?: boolean,
>     type?: boolean | number | string | date | email | gender | country | consent | phone | permission | string,
>     permissionHTML?: string
>   }[],
>   belongsToLists?: string[],
>   listsHistory?: {
>     date?: string,
>     listId?: number,
>     status?: added | deleted | string,
>     _links?: {
>       href: string | null,
>       rel: string,
>       description?: string
>     }[]
>   }[],
>   unsubscribedDate?: string | null,
>   unsubscriptionDate?: string | null,
>   unsubscriptionType?: hardBounce | softBounce | neverOpen | abuseLink | feedbackLoop | internalPolicies | manual | string | null,
>   manualUnsubscriptionReason?: administrative | subscriberRequestNeverSubscribed | subscriberRequestNotInterestingContent | subscriberRequestIsSpam | subscriberRequestTooManyEmails | subscriberRequestOther | null,
>   unsubscriptionComment?: string | null,
>   status?: active | pending | unsubscribed | standBy | archived | string | null,
>   canBeReactivated?: boolean | null,
>   isBeingReactivated?: boolean | null,
>   userId?: number,
>   score?: number,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }[]
> ```

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### listForList

`subscribers.listForList`

List subscribers in a list

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.subscribers.listForList({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `listId` | `number` | Yes | — |
| `page` | `number` | No | — |
| `per_page` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `items` | `object[]` | Yes | — |
| `pageSize` | `number` | No | — |
| `itemsCount` | `number` | No | — |
| `currentPage` | `number` | No | — |
| `pagesCount` | `number` | No | — |
| `lastPage` | `number` | No | — |
| `_links` | `object[]` | No | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   email: string,
>   fields?: {
>     name: string,
>     value: string,
>     predefined?: boolean,
>     private?: boolean,
>     readonly?: boolean,
>     type?: boolean | number | string | date | email | gender | country | consent | phone | permission | string,
>     permissionHTML?: string
>   }[],
>   belongsToLists?: string[],
>   listsHistory?: {
>     date?: string,
>     listId?: number,
>     status?: added | deleted | string,
>     _links?: {
>       href: string | null,
>       rel: string,
>       description?: string
>     }[]
>   }[],
>   unsubscribedDate?: string | null,
>   unsubscriptionDate?: string | null,
>   unsubscriptionType?: hardBounce | softBounce | neverOpen | abuseLink | feedbackLoop | internalPolicies | manual | string | null,
>   manualUnsubscriptionReason?: administrative | subscriberRequestNeverSubscribed | subscriberRequestNotInterestingContent | subscriberRequestIsSpam | subscriberRequestTooManyEmails | subscriberRequestOther | null,
>   unsubscriptionComment?: string | null,
>   status?: active | pending | unsubscribed | standBy | archived | string | null,
>   canBeReactivated?: boolean | null,
>   isBeingReactivated?: boolean | null,
>   userId?: number,
>   score?: number,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }[]
> ```

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### listUnsubscribed

`subscribers.listUnsubscribed`

List unsubscribed subscribers

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.subscribers.listUnsubscribed({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `page` | `number` | No | — |
| `per_page` | `number` | No | — |
| `from` | `string` | No | — |
| `to` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `items` | `object[]` | Yes | — |
| `pageSize` | `number` | No | — |
| `itemsCount` | `number` | No | — |
| `currentPage` | `number` | No | — |
| `pagesCount` | `number` | No | — |
| `lastPage` | `number` | No | — |
| `_links` | `object[]` | No | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   email: string,
>   fields?: {
>     name: string,
>     value: string,
>     predefined?: boolean,
>     private?: boolean,
>     readonly?: boolean,
>     type?: boolean | number | string | date | email | gender | country | consent | phone | permission | string,
>     permissionHTML?: string
>   }[],
>   belongsToLists?: string[],
>   listsHistory?: {
>     date?: string,
>     listId?: number,
>     status?: added | deleted | string,
>     _links?: {
>       href: string | null,
>       rel: string,
>       description?: string
>     }[]
>   }[],
>   unsubscribedDate?: string | null,
>   unsubscriptionDate?: string | null,
>   unsubscriptionType?: hardBounce | softBounce | neverOpen | abuseLink | feedbackLoop | internalPolicies | manual | string | null,
>   manualUnsubscriptionReason?: administrative | subscriberRequestNeverSubscribed | subscriberRequestNotInterestingContent | subscriberRequestIsSpam | subscriberRequestTooManyEmails | subscriberRequestOther | null,
>   unsubscriptionComment?: string | null,
>   status?: active | pending | unsubscribed | standBy | archived | string | null,
>   canBeReactivated?: boolean | null,
>   isBeingReactivated?: boolean | null,
>   userId?: number,
>   score?: number,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }[]
> ```

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### permissionsHistory

`subscribers.permissionsHistory`

Get subscriber permission history

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.subscribers.permissionsHistory({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `email` | `string` | Yes | — |
| `fieldName` | `string` | Yes | — |
| `page` | `number` | No | — |
| `per_page` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `items` | `object[]` | Yes | — |
| `pageSize` | `number` | No | — |
| `itemsCount` | `number` | No | — |
| `currentPage` | `number` | No | — |
| `pagesCount` | `number` | No | — |
| `lastPage` | `number` | No | — |
| `_links` | `object[]` | No | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   date?: string,
>   originIP?: string,
>   value?: string,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }[]
> ```

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### removeFromList

`subscribers.removeFromList`

Remove a subscriber from a list

**Risk:** `write`

```ts theme={null}
await corsair.dopplermarketingautomation.api.subscribers.removeFromList({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `listId` | `number` | Yes | — |
| `email` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### unsubscribe

`subscribers.unsubscribe`

Unsubscribe a subscriber from the account

**Risk:** `destructive`

```ts theme={null}
await corsair.dopplermarketingautomation.api.subscribers.unsubscribe({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `subscriber` | `object` | Yes | — |

> [accordion] subscriber full type
>
> ```ts theme={null}
> {
>   email: string,
>   fields?: {
>     name: string,
>     value: string,
>     predefined?: boolean,
>     private?: boolean,
>     readonly?: boolean,
>     type?: boolean | number | string | date | email | gender | country | consent | phone | permission | string,
>     permissionHTML?: string
>   }[],
>   belongsToLists?: string[],
>   listsHistory?: {
>     date?: string,
>     listId?: number,
>     status?: added | deleted | string,
>     _links?: {
>       href: string | null,
>       rel: string,
>       description?: string
>     }[]
>   }[],
>   unsubscribedDate?: string | null,
>   unsubscriptionDate?: string | null,
>   unsubscriptionType?: hardBounce | softBounce | neverOpen | abuseLink | feedbackLoop | internalPolicies | manual | string | null,
>   manualUnsubscriptionReason?: administrative | subscriberRequestNeverSubscribed | subscriberRequestNotInterestingContent | subscriberRequestIsSpam | subscriberRequestTooManyEmails | subscriberRequestOther | null,
>   unsubscriptionComment?: string | null,
>   status?: active | pending | unsubscribed | standBy | archived | string | null,
>   canBeReactivated?: boolean | null,
>   isBeingReactivated?: boolean | null,
>   userId?: number,
>   score?: number,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

## Tasks

### get

`tasks.get`

Get a task

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.tasks.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `taskId` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `taskId` | `string \| null` | No | — |
| `startDate` | `string \| null` | No | — |
| `finishDate` | `string \| null` | No | — |
| `taskType` | `string \| null` | No | — |
| `itemsProcessed` | `number \| null` | No | — |
| `status` | `unknown \| standBy \| inProgress \| completed \| failed \| string \| null` | No | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### importErrors

`tasks.importErrors`

List task import errors

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.tasks.importErrors({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `taskId` | `string` | Yes | — |
| `page` | `number` | No | — |
| `per_page` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `items` | `object[]` | Yes | — |
| `pageSize` | `number` | No | — |
| `itemsCount` | `number` | No | — |
| `currentPage` | `number` | No | — |
| `pagesCount` | `number` | No | — |
| `lastPage` | `number` | No | — |
| `_links` | `object[]` | No | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   errorCode?: string | null,
>   email?: string | null,
>   itemNumber?: number | null,
>   actionTaken?: string | null
> }[]
> ```

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### list

`tasks.list`

List account tasks

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.tasks.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `page` | `number` | No | — |
| `per_page` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `items` | `object[]` | Yes | — |
| `pageSize` | `number` | No | — |
| `itemsCount` | `number` | No | — |
| `currentPage` | `number` | No | — |
| `pagesCount` | `number` | No | — |
| `lastPage` | `number` | No | — |
| `_links` | `object[]` | No | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   taskId?: string | null,
>   startDate?: string | null,
>   finishDate?: string | null,
>   taskType?: string | null,
>   itemsProcessed?: number | null,
>   status?: unknown | standBy | inProgress | completed | failed | string | null,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }[]
> ```

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

## Templates

### create

`templates.create`

Create a double opt-in template

**Risk:** `write`

```ts theme={null}
await corsair.dopplermarketingautomation.api.templates.create({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `template` | `object` | Yes | — |

> [accordion] template full type
>
> ```ts theme={null}
> {
>   dobleOptinTemplateId?: number,
>   fromName: string,
>   fromEmail: string,
>   subject: string,
>   name: string,
>   preheader?: string | null,
>   replyTo?: string | null,
>   urlLanding: string,
>   _links?: {
>     href: string | null,
>     rel: string,
>     description?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |
| `createdResourceId` | `string` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### get

`templates.get`

Get a double opt-in template

**Risk:** `read`

```ts theme={null}
await corsair.dopplermarketingautomation.api.templates.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `templateId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `dobleOptinTemplateId` | `number` | No | — |
| `fromName` | `string` | Yes | — |
| `fromEmail` | `string` | Yes | — |
| `subject` | `string` | Yes | — |
| `name` | `string` | Yes | — |
| `preheader` | `string \| null` | No | — |
| `replyTo` | `string \| null` | No | — |
| `urlLanding` | `string` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***

### updateContent

`templates.updateContent`

Update double opt-in template HTML

**Risk:** `write`

```ts theme={null}
await corsair.dopplermarketingautomation.api.templates.updateContent({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountName` | `string` | Yes | — |
| `templateId` | `number` | Yes | — |
| `Body` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |
| `_links` | `object[]` | No | — |

> [accordion] \_links full type
>
> ```ts theme={null}
> {
>   href: string | null,
>   rel: string,
>   description?: string
> }[]
> ```

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.