---
title: "POST /recordEmailingRule"
method: POST
path: "/recordEmailingRule"
tags: ["recordEmailingRule"]
---

# POST /recordEmailingRule

`POST /recordEmailingRule`

## Request

- Base URL: `https://www.weclapp.com/api/nullapi/v2`
- URL: `https://www.weclapp.com/api/nullapi/v2/recordEmailingRule`
- Auth: API key in header `AuthenticationToken`
- TypeScript: <https://skmtc.dev/weclapp/apis/weclapp-api/docs/recordEmailingRule/post.ts> (a function with typed inputs; its response is checked against the schema)

create a recordEmailingRule

## Query parameters

- `dryRun` boolean

## Request body

- RecordEmailingRule
  - `id` string
  - `version` string
  - `active` boolean
  - `attachPurchaseOrderRequestCsvFile` boolean
  - `attachRecordDocument` boolean
  - `attachReturnLabel` boolean
  - `attachShippingLabel` boolean
  - `bccRecipients` string
  - `ccRecipients` string
  - `createdDate` integer
  - `event` 'CREDIT_ADVICE_CANCELLATION_DOCUMENT_CREATED' | 'CREDIT_ADVICE_CANCELLED' | 'CREDIT_ADVICE_CREATED' | 'CREDIT_ADVICE_DOCUMENT_CREATED' | 'CREDIT_ADVICE_ENTRY_COMPLETED' | 'CREDIT_ADVICE_OPEN_ITEM_CREATED' | 'CREDIT_ADVICE_OPEN_ITEM_PAID' | 'PERFORMANCE_RECORD_CANCELLED' | 'PERFORMANCE_RECORD_DOCUMENT_CREATED' | 'PERFORMANCE_RECORD_RECORDED' | 'PURCHASE_ORDER_CANCELLED' | 'PURCHASE_ORDER_CLOSED' | 'PURCHASE_ORDER_CONFIRMED' | 'PURCHASE_ORDER_DOCUMENTS_PRINTED' | 'PURCHASE_ORDER_DROPSHIPPING_DELIVERY_NOTE_PRINTED' | 'PURCHASE_ORDER_MANUALLY_CLOSED' | 'PURCHASE_ORDER_REQUEST_DECLINED' | 'PURCHASE_ORDER_REQUEST_REQUESTED' | 'QUOTATION_ACCEPTED' | 'QUOTATION_DOCUMENT_CREATED' | 'QUOTATION_ENTRY_COMPLETED' | 'QUOTATION_INQUIRED' | 'QUOTATION_REJECTED' | 'RETURN_CREDIT_NOTE_CREATED' | 'RETURN_LABEL_PRINTED' | 'RETURN_MOVED_INTO_STORE' | 'SALES_INVOICE_CANCELLATION_DOCUMENT_CREATED' | 'SALES_INVOICE_CANCELLED' | 'SALES_INVOICE_CREATED' | 'SALES_INVOICE_DOCUMENT_CREATED' | 'SALES_INVOICE_ENTRY_COMPLETED' | 'SALES_INVOICE_OPEN_ITEM_CREATED' | 'SALES_INVOICE_OPEN_ITEM_PAID' | 'SALES_ORDER_CANCELLED' | 'SALES_ORDER_CLOSED' | 'SALES_ORDER_CONFIRMATION_PRINTED' | 'SALES_ORDER_INVOICED' | 'SALES_ORDER_MANUALLY_CLOSED' | 'SALES_ORDER_PARTIALLY_SHIPPED' | 'SALES_ORDER_SHIPMENT_RECORD_CREATED' | 'SALES_ORDER_SHIPMENT_RECORD_PARTIALLY_CREATED' | 'SALES_ORDER_SHIPPED' | 'SHIPMENT_CANCELLED' | 'SHIPMENT_CONFIRMATION_OF_ARRIVAL_CREATED' | 'SHIPMENT_DELIVERY_NOTE_PRINTED' | 'SHIPMENT_DROPSHIPPING_DELIVERY_NOTE_PRINTED' | 'SHIPMENT_DROPSHIPPING_SHIPPED' | 'SHIPMENT_RETURN_LABEL_PRINTED' | 'SHIPMENT_SHIPPED' | 'SUPPLIER_RETURN_DELIVERY_NOTE_PRINTED' | 'SUPPLIER_RETURN_RETURN_LABEL_PRINTED' | 'SUPPLIER_RETURN_SHIPPED', required
  - `lastModifiedDate` integer
  - `mailAccountId` string
  - `name` string
  - `otherRecipients` string
  - `paymentMethods` OnlyId[]
    - `id` string
  - `performanceRecordInvoicingModes` string[]
  - `purchaseCreditAdviceTypes` string[]
  - `recipientType` 'OTHER_RECIPIENT' | 'RECORD_RECIPIENT', required
  - `salesChannels` string[]
  - `salesInvoiceOrigins` string[]
  - `salesInvoiceTypes` string[]
  - `salesOrderOrigins` string[]
  - `shipmentOutTypes` string[]
  - `templateId` string, required

## Response `201`

recordEmailingRule create response

- RecordEmailingRule
  - `id` string
  - `version` string
  - `active` boolean
  - `attachPurchaseOrderRequestCsvFile` boolean
  - `attachRecordDocument` boolean
  - `attachReturnLabel` boolean
  - `attachShippingLabel` boolean
  - `bccRecipients` string
  - `ccRecipients` string
  - `createdDate` integer
  - `event` 'CREDIT_ADVICE_CANCELLATION_DOCUMENT_CREATED' | 'CREDIT_ADVICE_CANCELLED' | 'CREDIT_ADVICE_CREATED' | 'CREDIT_ADVICE_DOCUMENT_CREATED' | 'CREDIT_ADVICE_ENTRY_COMPLETED' | 'CREDIT_ADVICE_OPEN_ITEM_CREATED' | 'CREDIT_ADVICE_OPEN_ITEM_PAID' | 'PERFORMANCE_RECORD_CANCELLED' | 'PERFORMANCE_RECORD_DOCUMENT_CREATED' | 'PERFORMANCE_RECORD_RECORDED' | 'PURCHASE_ORDER_CANCELLED' | 'PURCHASE_ORDER_CLOSED' | 'PURCHASE_ORDER_CONFIRMED' | 'PURCHASE_ORDER_DOCUMENTS_PRINTED' | 'PURCHASE_ORDER_DROPSHIPPING_DELIVERY_NOTE_PRINTED' | 'PURCHASE_ORDER_MANUALLY_CLOSED' | 'PURCHASE_ORDER_REQUEST_DECLINED' | 'PURCHASE_ORDER_REQUEST_REQUESTED' | 'QUOTATION_ACCEPTED' | 'QUOTATION_DOCUMENT_CREATED' | 'QUOTATION_ENTRY_COMPLETED' | 'QUOTATION_INQUIRED' | 'QUOTATION_REJECTED' | 'RETURN_CREDIT_NOTE_CREATED' | 'RETURN_LABEL_PRINTED' | 'RETURN_MOVED_INTO_STORE' | 'SALES_INVOICE_CANCELLATION_DOCUMENT_CREATED' | 'SALES_INVOICE_CANCELLED' | 'SALES_INVOICE_CREATED' | 'SALES_INVOICE_DOCUMENT_CREATED' | 'SALES_INVOICE_ENTRY_COMPLETED' | 'SALES_INVOICE_OPEN_ITEM_CREATED' | 'SALES_INVOICE_OPEN_ITEM_PAID' | 'SALES_ORDER_CANCELLED' | 'SALES_ORDER_CLOSED' | 'SALES_ORDER_CONFIRMATION_PRINTED' | 'SALES_ORDER_INVOICED' | 'SALES_ORDER_MANUALLY_CLOSED' | 'SALES_ORDER_PARTIALLY_SHIPPED' | 'SALES_ORDER_SHIPMENT_RECORD_CREATED' | 'SALES_ORDER_SHIPMENT_RECORD_PARTIALLY_CREATED' | 'SALES_ORDER_SHIPPED' | 'SHIPMENT_CANCELLED' | 'SHIPMENT_CONFIRMATION_OF_ARRIVAL_CREATED' | 'SHIPMENT_DELIVERY_NOTE_PRINTED' | 'SHIPMENT_DROPSHIPPING_DELIVERY_NOTE_PRINTED' | 'SHIPMENT_DROPSHIPPING_SHIPPED' | 'SHIPMENT_RETURN_LABEL_PRINTED' | 'SHIPMENT_SHIPPED' | 'SUPPLIER_RETURN_DELIVERY_NOTE_PRINTED' | 'SUPPLIER_RETURN_RETURN_LABEL_PRINTED' | 'SUPPLIER_RETURN_SHIPPED', required
  - `lastModifiedDate` integer
  - `mailAccountId` string
  - `name` string
  - `otherRecipients` string
  - `paymentMethods` OnlyId[]
    - `id` string
  - `performanceRecordInvoicingModes` string[]
  - `purchaseCreditAdviceTypes` string[]
  - `recipientType` 'OTHER_RECIPIENT' | 'RECORD_RECIPIENT', required
  - `salesChannels` string[]
  - `salesInvoiceOrigins` string[]
  - `salesInvoiceTypes` string[]
  - `salesOrderOrigins` string[]
  - `shipmentOutTypes` string[]
  - `templateId` string, required

## Other responses

- `default`: error response

## Changes

- **2026-11-07** `0e021229755d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/weclapp/apis/weclapp-api/changes/recordEmailingRule/post.md)

---

[API](https://skmtc.dev/weclapp/apis/weclapp-api.md) - [All operations](https://skmtc.dev/weclapp/apis/weclapp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/weclapp/apis/weclapp-api/revisions/0e021229755d?raw)
