Premiere V2 API

Appearance

v12.11.0

V2 Staging API Documentation​

Download OpenAPI Document

REST API v2. Authenticate with a Bearer JWT in the Authorization header unless an endpoint is marked public.

Servers​

https://v2-staging.tscheckout.comCurrent host

Retrieve the list of email templates​

GET
/api/v2/email-manager/

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Query Parameters

name

Name of template to find

Type
string
type

Type of template to find

Type
string

Responses​

Playground​

Authorization
Variables
Key
Value

Samples​

Create an email template​

POST
/api/v2/email-manager/

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
{
  
"name": "string",
  
"type": "string",
  
"subject": "string",
  
"body": "string",
  
"customSection1": "string",
  
"customSection2": "string",
  
"customSection3": "string",
  
"customSection4": "string"
}

Responses​

Playground​

Authorization
Body

Samples​

Retrieve a specific email template​

GET
/api/v2/email-manager/{id}

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

id

Type
integer
Required
Format
"int64"

Responses​

Playground​

Authorization
Variables
Key
Value

Samples​

Send an Email​

POST
/api/v2/email-manager/send-email

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
{
  
"to": "string",
  
"subject": "string",
  
"body": "string"
}

Responses​

Playground​

Authorization
Body

Samples​

Send an Email from a template​

POST
/api/v2/email-manager/send-email-with-template

Creates an Email Template

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
{
  
"to": "string",
  
"templateName": "string",
  
"templateType": "string",
  
"substitutionArray": "string",
  
"delimiters": "string"
}

Responses​

Playground​

Authorization
Body

Samples​

Powered by VitePress OpenAPI