> For the complete documentation index, see [llms.txt](https://developers.flipsnack.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.flipsnack.com/api-reference/collection.sendemail.md).

# collection.sendEmail

Sends a published flipbook via email to one or more recipients

**Note**:

* requests must be made to **<https://api.flipsnack.com/v1>**;
* supports only POST method;
* the flipbook must be published before it can be sent;

## Request parameters

| **Name**                  | **Type** | **Description**                                                                                                                                                                                                                                       |
| ------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| apiKey (required)         | string   | The API key provided for your user. If it is not specified, the request will return the error code "30 - Missing mandatory parameter". If the key is incorrect the request returns the error code "41 - Invalid credentials".                         |
| signature (required)      | string   | The signature must be calculated by you and added to the request. See "How to sign a request". If missing, returns error "30 - Missing mandatory parameter". If incorrect, returns error "44 - Invalid signature".                                    |
| action (required)         | string   | The API method that should be called. In this case the value should be collection.sendEmail. If not specified, returns error "30 - Missing mandatory parameter".                                                                                      |
| collectionHash (required) | string   | The hash of the flipbook to send. The flipbook must be published — sending an editable or processing flipbook returns an error.                                                                                                                       |
| recipients (required)     | string   | Comma-separated list of recipient email addresses (e.g. <a@example.com>,<b@example.com>). Maximum count depends on your plan (see API limitations). Invalid addresses are skipped and reported in the response rather than failing the whole request. |
| subject (required)        | string   | The subject line of the email.                                                                                                                                                                                                                        |
| title (required)          | string   | The headline displayed inside the email body, above the flipbook preview.                                                                                                                                                                             |
| message (required)        | string   | The descriptive text displayed inside the email body.                                                                                                                                                                                                 |
| ctaLabel                  | string   | The label of the call-to-action button that opens the flipbook. Default: *"View flipbook"*.                                                                                                                                                           |

## Response parameters

| **Name**             | **Type**        | **Description**                                                     |
| -------------------- | --------------- | ------------------------------------------------------------------- |
| emailsQueued         | number          | Count of recipients successfully queued for delivery.               |
| dailyLimit           | number          | Maximum number of emails that may be sent within a single day.      |
| emailsSentToday      | number          | Number of emails sent so far today, excluding this request.         |
| emailsRemainingToday | number          | Remaining send allowance for today.                                 |
| skippedRecipients    | array of string | Recipient addresses not queued because the daily limit was reached. |
| invalidRecipients    | array of string | Recipient addresses rejected as malformed or otherwise invalid.     |

## Error codes

| **Code** | **Message**                                                           | **Notes**                                                                                        |
| -------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| 30       | Missing mandatory parameter                                           | collectionHash, recipients, subject, title, and message were not provided in the request.        |
| 41       | Invalid credentials                                                   | The apiKey is missing, malformed, or not recognized.                                             |
| 43       | Send email via API is only available for published flipbooks          | The target flipbook is not published.                                                            |
| 43       | Send email via API is only available for public or unlisted flipbooks | The target flipbook is private.                                                                  |
| 43       | Send email is not available on your plan                              | The send-email feature is not enabled for the account's plan.                                    |
| 43       | Sending to multiple recipients is not available on your plan          | Sending to more than one recipient is not enabled for the account's plan.                        |
| 44       | Invalid signature                                                     | The signature does not match the value computed from the request parameters.                     |
| 46       | Flipbook not found                                                    | No flipbook matches the supplied collectionHash, or it is not accessible with these credentials. |
| 50       | Operation failed                                                      | The request was valid but could not be completed due to a server-side error. Retry the request.  |

For complete list of error codes and messages go to [API status codes](https://developers.flipsnack.com/api-status-codes) section.

## Example

### Request

```bash
curl -X POST "https://api.flipsnack.com/v1/" \
-F action="collection.sendEmail" \
-F apiKey=<YOUR-API-KEY> \
-F signature=<YOUR-REQUEST-SIGNATURE> \
-F collectionHash="d3m0h45h" \
-F recipients="jane@example.com,john@example.com" \
-F subject="Our new Spring catalog is here" \
-F title="Check out what's new this Spring" \
-F message="We just published our latest catalog, packed with new arrivals." \
-F ctaLabel="View catalog"
```

### Response

```json
{
  "code": 20,
  "status": "OK",
  "data": {
    "emailsQueued": 1,
    "dailyLimit": 1000,
    "emailsSentToday": 2,
    "emailsRemainingToday": 998,
    "skippedRecipients": [],
    "invalidRecipients": [],
  }
}
```