Send Email Using Template

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Send a transactional email using a pre-created CPaaS template.

Endpoint

Request URL

https://cpaas.zoho.com/v1.1/email/template Copied!

Request Parameters

- Request Headers

ApiKeyAuthAPI Key

API Key of an agent. Send the header as Authorization: Zoho-enczapikey {apiKey}.
Follow the steps here to generate an API key.

- Request Body

application/json
JSON Object
Show Sub-Attributes
template_keystringOptional

Unique key of the email template. Use either template_key or template_alias.

Example
1234567890
template_aliasstringOptional

Alias of the email template. Use either template_alias or template_key.

Example
account-confirmation
fromobjectMandatory

The sender's email address and optional display name.

addressstringMandatory
Example
accounts@info.zylker.com
namestringOptional
Example
Paula
toarray[object]Mandatory

Array of recipient email addresses.

email_addressJSON ObjectOptional
Show Sub-Attributes
addressstringOptional
Example
rudra.d@zylker.com
namestringOptional
Example
Rudra
ccarray[object]Optional

Array of CC recipient email addresses.

email_addressJSON ObjectOptional
Show Sub-Attributes
addressstringOptional
Example
manager@zylker.com
namestringOptional
Example
Manager
bccarray[object]Optional

Array of BCC recipient email addresses.

email_addressJSON ObjectOptional
Show Sub-Attributes
addressstringOptional
Example
archive@zylker.com
namestringOptional
Example
Archive
reply_toarray[object]Optional

Reply-to email address.

addressstringOptional
Example
support@zylker.com
namestringOptional
Example
Support
merge_infoobjectOptional

Key-value pairs to replace template variables.

Example
{
  "account_id": "98765",
  "user_name": "Rudra"
}
Additional propertiesstring
Any additional property defined using a custom key.
attachmentsarray[object]Optional

Array of file attachments.

file_cache_keystringOptional
Example
fc-xxxx-xxxx
mime_typestringOptional
Example
application/pdf
namestringOptional
Example
invoice.pdf
contentstringOptional

Base64-encoded file content.

track_clicksbooleanOptional

Enable or disable click tracking.

Example
true
track_opensbooleanOptional

Enable or disable open tracking.

Example
true
client_referencestringOptional

A custom reference string to identify the email in your system.

Example
order-12345

Sample Request

Curl
Java
Python
Deluge
Copied!
curl --request POST \
  --url https://cpaas.zoho.com/v1.1/email/template \
  --header 'Authorization: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"template_key":"1234567890","template_alias":"account-confirmation","from":{"address":"accounts@info.zylker.com","name":"Paula"},"to":[{"email_address":{"address":"rudra.d@zylker.com","name":"Rudra"}}],"cc":[{"email_address":{"address":"manager@zylker.com","name":"Manager"}}],"bcc":[{"email_address":{"address":"archive@zylker.com","name":"Archive"}}],"reply_to":[{"address":"support@zylker.com","name":"Support"}],"merge_info":{"account_id":"98765","user_name":"Rudra"},"attachments":[{"file_cache_key":"fc-xxxx-xxxx","mime_type":"application/pdf","name":"invoice.pdf","content":"string"}],"track_clicks":true,"track_opens":true,"client_reference":"order-12345"}'

Sample Request Body

Copied!
  {
    "template_key": "1234567890",
    "template_alias": "account-confirmation",
    "from": {
      "address": "accounts@info.zylker.com",
      "name": "Paula"
    },
    "to": [
      {
        "email_address": {
          "address": "rudra.d@zylker.com",
          "name": "Rudra"
        }
      }
    ],
    "cc": [
      {
        "email_address": {
          "address": "manager@zylker.com",
          "name": "Manager"
        }
      }
    ],
    "bcc": [
      {
        "email_address": {
          "address": "archive@zylker.com",
          "name": "Archive"
        }
      }
    ],
    "reply_to": [
      {
        "address": "support@zylker.com",
        "name": "Support"
      }
    ],
    "merge_info": {
      "account_id": "98765",
      "user_name": "Rudra"
    },
    "attachments": [
      {
        "file_cache_key": "fc-xxxx-xxxx",
        "mime_type": "application/pdf",
        "name": "invoice.pdf",
        "content": "string"
      }
    ],
    "track_clicks": true,
    "track_opens": true,
    "client_reference": "order-12345"
  }
                
▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Show Sub-Attributes
dataarray[object]
messagestringread-only
Example
OK
request_idstringread-only
Example
req-xxxx

- HTTP code 400

Response Body - application/json
JSON Object
Show Sub-Attributes
dataJSON Object
Show Sub-Attributes
error_codestringread-only
Example
TM_3004
messagestringread-only
Example
Invalid request
messagestringread-only
Example
error

Sample Response: HTTP 200

Copied!
  {
    "data": [
      {
        "code": "EM_104",
        "message": "OK"
      }
    ],
    "message": "OK",
    "request_id": "req-xxxx"
  }
                
▼ Show full

Sample Response: HTTP 400

Copied!
  {
    "data": {
      "error_code": "TM_3004",
      "message": "Invalid request"
    },
    "message": "error"
  }
                
▼ Show full