Email Templates

List email templates for the tenant

get

/api/{tenantId}/admin/emailTemplates

Returns every template id found under server/stripo/ along with the cultures it has design content for.

Authorization

Requires tenant.configuration.emailTemplate:read scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Responses

200

Email templates returned.

Email template returned by the list endpoint.

idstringRequired

Template identifier.

culturesstring[]Required

Cultures for which this template has design content.

get/api/{tenantId}/admin/emailTemplates

GET /api/{tenantId}/admin/emailTemplates HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Email templates returned.

[
  {
    "id": "text",
    "cultures": [
      "text"
    ]
  }
]

Create a new email template

post

/api/{tenantId}/admin/emailTemplates

Creates the design source (and, if provided, the compiled subject/body) for one or more cultures of a new template. To duplicate an existing template, GET its content first and POST it back under a new id (or a new culture) here — there is no dedicated duplicate endpoint.

Authorization

Requires tenant.configuration.emailTemplate:write scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Body

Request body to create a new email template.

idstring · min: 1Required

Template identifier. Only alphanumeric characters, hyphens, underscores, dots and spaces are allowed, up to 50 characters.

Responses

201

Email template created.

Full definition of an email template, returned by get/create/save endpoints.

idstringRequired

Template identifier.

400

Id or culture is invalid, or no culture was provided.

409

A template with this id already exists.

post/api/{tenantId}/admin/emailTemplates

POST /api/{tenantId}/admin/emailTemplates HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "id": "text",
  "cultures": {
    "ANY_ADDITIONAL_PROPERTY": {
      "html": "text",
      "css": "text",
      "subject": null,
      "body": null
    }
  }
}

{
  "id": "text",
  "cultures": {
    "ANY_ADDITIONAL_PROPERTY": {
      "html": "text",
      "css": "text",
      "subject": null,
      "body": null
    }
  }
}

Get an email template

get

/api/{tenantId}/admin/emailTemplates/{id}

Returns the design source (HTML/CSS) and, when available, the compiled subject/body for every culture of the template identified by id.

Authorization

Requires tenant.configuration.emailTemplate:read scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2implicitRequired

Authorization URL:

Path parameters

idstringRequired

tenantIdstringRequired

Responses

200

Email template returned.

Full definition of an email template, returned by get/create/save endpoints.

idstringRequired

Template identifier.

404

Email template not found.

get/api/{tenantId}/admin/emailTemplates/{id}

GET /api/{tenantId}/admin/emailTemplates/{id} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "text",
  "cultures": {
    "ANY_ADDITIONAL_PROPERTY": {
      "html": "text",
      "css": "text",
      "subject": null,
      "body": null
    }
  }
}

Save an email template

put

/api/{tenantId}/admin/emailTemplates/{id}

Upserts the design source (and, if provided, the compiled subject/body) for one or more cultures of an existing template. Cultures not present in the request body are left untouched.

Authorization

Requires tenant.configuration.emailTemplate:write scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2implicitRequired

Authorization URL:

Path parameters

idstringRequired

tenantIdstringRequired

Body

Request body to save (create or update) culture content on an existing email template.

Responses

200

Email template saved.

Full definition of an email template, returned by get/create/save endpoints.

idstringRequired

Template identifier.

400

A culture is invalid, or no culture was provided.

404

Email template not found.

put/api/{tenantId}/admin/emailTemplates/{id}

PUT /api/{tenantId}/admin/emailTemplates/{id} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "cultures": {
    "ANY_ADDITIONAL_PROPERTY": {
      "html": "text",
      "css": "text",
      "subject": null,
      "body": null
    }
  }
}

{
  "id": "text",
  "cultures": {
    "ANY_ADDITIONAL_PROPERTY": {
      "html": "text",
      "css": "text",
      "subject": null,
      "body": null
    }
  }
}

Delete an email template

delete

/api/{tenantId}/admin/emailTemplates/{id}

Deletes the design source and compiled subject/body for the specified culture. When culture is omitted, deletes every culture of the template.

Authorization

Requires tenant.configuration.emailTemplate:write scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2implicitRequired

Authorization URL:

Path parameters

idstringRequired

tenantIdstringRequired

Query parameters

culturestringOptional

Responses

204

Email template (or culture) deleted.

No content

400

Culture is invalid.

404

Email template (or culture) not found.

delete/api/{tenantId}/admin/emailTemplates/{id}

DELETE /api/{tenantId}/admin/emailTemplates/{id} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content