POST /crm/v5/{module_API_name}/{record_id}/actions/send_mail_merge

Send Mail Merge

Servers

Path parameters

Name Type Required Description
module_API_name String Yes
record_id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
send_mail_merge[] Array No
send_mail_merge[].mail_merge_template Object No
send_mail_merge[].mail_merge_template.id String No
send_mail_merge[].mail_merge_template.name String No
send_mail_merge[].from_address Object No
send_mail_merge[].from_address.type String No
send_mail_merge[].from_address.value String No
send_mail_merge[].message String No
send_mail_merge[].cc_email[] Array No
send_mail_merge[].cc_email[].type String No
send_mail_merge[].cc_email[].value String No
send_mail_merge[].type String No
send_mail_merge[].bcc_email[] Array No
send_mail_merge[].bcc_email[].type String No
send_mail_merge[].bcc_email[].value String No
send_mail_merge[].subject String No
send_mail_merge[].attachment_name String No
send_mail_merge[].to_address[] Array No
send_mail_merge[].to_address[].type String No
send_mail_merge[].to_address[].value String No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.