Add Template

post https://api.getgreenspark.com/v1/email/templates

Add your notification template for email sending. If you do not want a customizable property to be custom, you should provide the default value for that property. You can get the default values for every template type from the templates-defaults endpoint.

Responses

Response body

object

string

required

The id of the template.

isActive

boolean

required

Start sending this template to your customers.

isCustom

boolean

required

Boolean flag indicates customized template.

type

object

required

isScheduleCustom

boolean

required

Boolean flag indicates customized schedule.

isTriggerCustom

boolean

required

Boolean flag indicates customized trigger.

name

string

required

Name of the template

schedule

array of strings

required

Sets how many days after an impact creation a signup nudging email is sent out to your customer.

schedule*

template

object

required

The type of the template.

Has additional fields

trigger

array of strings

required

Choose the impact action which triggers your email to be sent out.

trigger*

settings

object

required

alias

string

required

This is the name display for the specified sender email address.

from

object

required

The email address used for sending emails.

isAliasCustom

boolean

required

Boolean flag indicates customized alias.

isFromCustom

boolean

required

Boolean flag indicates customized sender email address.

isPreheaderCustom

boolean

required

Boolean flag indicates customized preheader.

isSubjectCustom

boolean

required

Boolean flag indicates customized subject.

preheader

string

required

The preheader is the text following the subject line when an email is previewed.

schedule

object

required

You can choose to send your template continuously starting at the selected start date or only during a specific date range.

subject

string

required

Your subject line is one of the first things that your customers read and is a key driver in successful open rates.

content

object

required

body

string

required

Use our pre-defined email body or customise it to fit your brand. Add dynamic data by using the variables provided.

headerImage

string

required

Add your own logo to the top of the email or use our pre-defined header image. If you use your own header image please ensure it is maximum 1370 x 700, or has a 2:1 aspect ratio.

isBodyCustom

boolean

required

Boolean flag indicates customized body.

isFooterHidden

boolean

required

Hide our email footer explaining the benefits of Greenspark.

isFooterHiddenCustom

boolean

required

Boolean flag indicates customized hidden footer setting.

isHeaderImageCustom

boolean

required

Boolean flag indicates customized header image.

isTotalImpactHidden

boolean

required

Hide your total impact so far within your emails.

isTotalImpactHiddenCustom

boolean

required

Boolean flag indicates customized hidden total impact setting.

400

Bad request.

401

Provide your API key.

403

Please upgrade to a growth, premium or enterprise plan.

404

Not found.

Language

Credentials

Header

URL


xxxxxxxxxx
16
1
curl --request POST \
2
     --url https://api.getgreenspark.com/v1/email/templates \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "isActive": true,
8
  "type": {
9
    "template": "invitation"
10
  },
11
  "content": {
12
    "isFooterHidden": true,
13
    "isTotalImpactHidden": true
14
  }
15
}
16
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Notification template has been successfully added.