---
title: "Email a credit memo"
method: POST
path: "/v1/credit-memos/{creditMemoKey}/emails"
tags: ["Credit Memos"]
---

# Email a credit memo

`POST /v1/credit-memos/{creditMemoKey}/emails`

**Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-invoice-settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide) for more information. 

Sends a posted credit memo to the specified email addresses manually.



### Notes
  - You must activate the **Email Credit Memo | Manually email Credit Memo** notification before emailing credit memos. To include the credit memo PDF in the email, select the **Include Credit Memo PDF** check box in the **Edit notification** dialog from the Zuora UI. See [Create and Edit Notifications](https://docs.zuora.com?resourceId=platform-create-notification) for more information.


  - Zuora sends the email messages based on the email template you set. You can set the email template to use in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. By default, the **Manual Email for Credit Memo Default Template** template is used. See [Create and Edit Email Templates](https://docs.zuora.com?resourceId=platform-create-email-template) for more information.


  - The credit memos are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met:

    * The `useEmailTemplateSetting` field is set to `false`.
    * The email addresses are not specified in the `emailAddresses` field.

## Path parameters

- `creditMemoKey` string, required

## Headers

- `Idempotency-Key` string
- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Version` string

## Request body

- PostCreditMemoEmailRequestType
  - `emailAddresses` string — The valid email addresses you want to email a credit memo to. Use commas to separate email addresses. **Note:** This field is only applicable if you set the `useEmailTemplateSetting` field to `false`.
  - `includeAdditionalEmailAddresses` true | false — Indicates whether to send a credit memo to the additional email addresses of the memo account. You can set the additional email addresses in the **Additional Email Addresses** field on the account detail page from the Zuora UI. See [Create a Customer Account](https://docs.zuora.com?resourceId=billing-create-customer-account) for more information.
  - `pdfFileId` string — The ID of the PDF file that you want to send in the email. If you do not specify any PDF file ID, the latest PDF file generated for the credit memo is sent in the email.
  - `useEmailTemplateSetting` true | false — Indicates whether to email a credit memo based on the email template setting. If you set this field to `true`, the credit memo is sent to the email addresses specified in the **To Email** field of the email template. The email template is the one you set in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. See [Edit Email Templates](https://docs.zuora.com?resourceId=platform-create-email-template) for more information about how to edit the **To Email** field in the email template.

## Response `200`

OK

- CommonResponse
  - `processId` string — The ID of the process that handles the operation.
  - `reasons` object[] — The container of the error code and message. This field is available only if the `success` field is `false`.
    - `code` string — The error code of response.
    - `message` string — The detail information of the error response
  - `requestId` string, uuid — Unique identifier of the request.
  - `success` boolean — Indicates whether the call succeeded.

## Other responses

- `500` — Internal Server Error
- `4XX` — Request Errors

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)