Skip to main content
PUT
Spree Admin SDK

Authorizations

x-spree-api-key
string
header
required

Secret API key for admin access

Authorization
string
header
required

JWT token for admin user authentication

Headers

x-spree-api-key
string
required
Authorization
string
required

Bearer token for admin authentication

Path Parameters

email_template_id
string
required

The template key with dots

Body

application/json
language
string

A language code, or any (the default) for the version every language uses.

Example:

"any"

subject
string | null
Example:

"Your order {{ order.number }} is confirmed"

body
string
Example:

"<mj-section><mj-column><mj-text>Thanks, {{ order.customer_name }}!</mj-text></mj-column></mj-section>"

lock_version
integer | null

The lock_version the draft was loaded with, or null when there was no draft; a save from an older copy is refused with 409. Omit it to save without checking.

Example:

0

rebase
boolean

Marks the draft as based on Spree's current default, after reviewing what changed in it.

Response

draft saved

id
string
required
key
string
required
subject
string | null
required
body
string
required
language
string
required
customized_languages
string[]
required
kind
enum<string>
required
Available options:
email,
layout,
partial
customized
boolean
required
published_at
string | null
required
default_subject
string | null
required
default_body
string
required
published_language
string | null
required
default_changed
boolean
required
base_subject
string | null
required
base_body
string | null
required
draft
object | null
required