Skip to main content
PATCH
/
api
/
email_templates
/
{heron_id}
Patch an email template
curl --request PATCH \
  --url https://app.herondata.io/api/email_templates/{heron_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "cc_address": null,
  "html_body": "<string>",
  "name": "<string>",
  "reply_to_address": null,
  "to_address": null
}'
{
  "email_template": {
    "cc_address": null,
    "heron_id": "<string>",
    "html_body": "<string>",
    "name": "<string>",
    "reply_to_address": null,
    "to_address": null
  }
}

Authorizations

x-api-key
string
header
required

Path Parameters

heron_id
string
required

Body

application/json
cc_address
string | null

The email address to CC

html_body
string

The body of the email to send.

name
string

Unique name of the email template. Used to match which email template to send. Only alphanumeric characters, underscores, and dashes are allowed.

Required string length: 3 - 50
reply_to_address
string | null

The email address to reply to

to_address
string | null

The email address to send the email to

Response

201 - application/json

OK

email_template
object
I