Skip to main content
POST
/
templates
Create a template
curl --request POST \
  --url https://apix.spotzee.com/api/client/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "email",
  "campaign_id": 123,
  "locale": "en-AU",
  "data": {
    "from": {
      "name": "<string>",
      "address": "jsmith@example.com"
    },
    "cc": "jsmith@example.com",
    "bcc": "jsmith@example.com",
    "reply_to": "jsmith@example.com",
    "subject": "<string>",
    "text": "<string>",
    "html": "<string>",
    "mjml": "<string>"
  }
}
'
{
  "id": 158,
  "project_id": 123,
  "campaign_id": 24,
  "type": "email",
  "locale": "en-AU",
  "data": {},
  "created_at": "<string>",
  "updated_at": "<string>",
  "name": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.spotzee.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Project-scoped secret API key (sk_…). Pass in the Authorization: Bearer <key> header. Grants access to the project the key was issued for.

Body

application/json

Create a new template. The type discriminator selects the channel-specific data shape.

​
type
enum<string>
required
Available options:
email
​
campaign_id
integer
required

Campaign this template belongs to.

​
locale
string
required

BCP-47 locale tag (for example en-AU).

Example:

"en-AU"

​
data
object
required

Email template payload — supports plain-text, HTML, and MJML bodies.

​
name
string | null

Response

The newly created template.

A localised, channel-specific message body bound to a campaign.

​
id
integer
required

Numeric template identifier.

Example:

158

​
project_id
integer
required

Identifier of the owning project.

​
campaign_id
integer
required

Identifier of the campaign this template belongs to.

Example:

24

​
type
enum<string>
required

Delivery channel a template is bound to.

Available options:
email,
text,
push,
webhook,
in_app
Example:

"email"

​
locale
string
required

BCP-47 locale this template is authored in.

Example:

"en-AU"

​
data
object
required

Channel-specific template body. Shape varies by type — see TemplateEmailData, TemplatePushData, etc.

​
created_at
string | null
required
​
updated_at
string | null
required
​
name
string | null

Optional human-readable template name.