Send an email to a record

POST/{moduleName}/{id}/actions/send_mail

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Send an email to a record action (under Email).
Fill in the fields below, then reference the result from later steps as {{sendAnEmailToARecord.response.data}}.

Request

Path parameters

moduleNamestringrequired

Specify the API name of the Zoho CRM module for which the record exists. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values. Supported modules: Leads, Contacts, Deals, Accounts, Sales Orders, Purchase Orders, Invoices, Quotes, Cases, Vendors, and Custom Modules.

idstringrequired

Specify the unique ID of the record to send the email to.

Request body

Enter the body as JSON in the step's Body field.

dataarray<object>required

Contains the list of email configuration objects to send.

fromobjectrequired2 fields

Represents an email user with an email address and an optional display name.

toarray<object>required2 fields

Represents the list of primary recipients of the email.

ccarray<object>2 fields

Represents the list of CC (carbon copy) recipients for the email.

bccarray<object>2 fields

Represents the list of BCC (blind carbon copy) recipients for the email.

reply_toobject2 fields

Represents an email user with an email address and an optional display name.

subjectstring

Represents the subject line of the email.

contentstring

Represents the body content of the email.

mail_formatstring

Represents the format of the email body. Possible values: **html** - HTML-formatted email. **text** - Plain text email.

One ofhtmltext

org_emailboolean

Indicates whether to send the email using the organization email address instead of the sender individual email address. Possible values: **true** - Sends the email using the organization email address. **false** - Sends the email using the sender individual email address.

scheduled_timestring (date-time)

Represents the scheduled date and time to send the email, in ISO 8601 date-time format.

consent_emailboolean

Indicates whether the email is a GDPR consent email. Possible values: **true** - The email is a GDPR consent request. **false** - The email is not a GDPR consent request.

templateobject1 fields

Represents the Email Template to use for the email. Refer to the [Get Email Templates](email_templates.yaml#$.paths./settings/email_templates.get) resource for valid values.

inventory_detailsobject3 fields

Represents the inventory template details to attach to the email.

data_subject_requestobject2 fields

Represents the GDPR data subject request associated with the email.

attachmentsarray<object>1 fields

Represents the list of files to attach to the email, referenced by their Zoho File System (ZFS) IDs.

json

{
  "data": [
    {
      "from": {
        "email": "string",
        "user_name": "string"
      },
      "to": [
        {
          "email": "string",
          "user_name": "string"
        }
      ],
      "cc": [
        {
          "email": "string",
          "user_name": "string"
        }
      ],
      "bcc": [
        {
          "email": "string",
          "user_name": "string"
        }
      ],
      "reply_to": {
        "email": "string",
        "user_name": "string"
      },
      "subject": "string",
      "content": "string",
      "mail_format": "html",
      "org_email": false,
      "scheduled_time": "2025-01-01T00:00:00Z",
      "consent_email": false,
      "template": {
        "id": "string"
      }
    }
  ]
}

Response

Returns 200 with an object. Read it in later steps with {{sendAnEmailToARecord.response.data.<field>}}.

dataarray<object>

Represents the list of mail-send results, one item per email request.

codestring

Represents the status code for the send operation. Possible values: **SUCCESS** - The email was sent successfully.

One ofSUCCESS

statusstring

Represents the status of the email send operation. Possible values: **success** - The email was sent successfully.

One ofsuccess

messagestring

Represents the status message for the send operation.

detailsobject1 fields

Represents additional metadata returned for the send operation, including the message identifier.

json

{
  "data": [
    {
      "code": "SUCCESS",
      "status": "success",
      "message": "string",
      "details": {
        "message_id": "string"
      }
    }
  ]
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.

Was this page helpful?