Developer docs menu

API reference / Email templates

Email templates API

5 endpoints. Scopes: Scalar360.email-templates.READ, .CREATE, .UPDATE, .DELETE or .ALL. All calls need Authorization: Scalar360-oauthtoken <access_token> — see Authentication.

GET

List

/api/v1/email-templates

Scope: Scalar360.email-templates.READ

Example request
curl -X GET "https://api.scalar360.com/api/v1/email-templates" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"
POST

Create

/api/v1/email-templates

Scope: Scalar360.email-templates.CREATE

Body fieldTypeRequiredNotes
namestringYesrequired, not blank
channelstring
subjectstring
bodystringYesrequired, not blank
Example request
curl -X POST "https://api.scalar360.com/api/v1/email-templates" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","body":"string"}'
PUT

Update

/api/v1/email-templates/{gid}

Scope: Scalar360.email-templates.UPDATE

ParameterInTypeRequired
gidpathstring (uuid)Yes
Body fieldTypeRequiredNotes
namestringYesrequired, not blank
channelstring
subjectstring
bodystringYesrequired, not blank
Example request
curl -X PUT "https://api.scalar360.com/api/v1/email-templates/{gid}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","channel":"string","subject":"string","body":"string"}'
DELETE

Delete

/api/v1/email-templates/{gid}

Scope: Scalar360.email-templates.DELETE

ParameterInTypeRequired
gidpathstring (uuid)Yes
Example request
curl -X DELETE "https://api.scalar360.com/api/v1/email-templates/{gid}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"
POST

Add samples

/api/v1/email-templates/samples

Scope: Scalar360.email-templates.CREATE

Example request
curl -X POST "https://api.scalar360.com/api/v1/email-templates/samples" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"