v2.84.0

TS Dev 108 API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

---

Email Manager

Endpoints to manage email templates and send messages

Operations

GET/api/v2/email-manager/POST/api/v2/email-manager/GET/api/v2/email-manager/{id}POST/api/v2/email-manager/send-emailPOST/api/v2/email-manager/send-email-with-template

---

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

GET

/api/v2/email-manager/

Playground

Authorization

bearerAuth

Variables

Key

Value

name

type

Samples

---

Create an email template

POST

/api/v2/email-manager/

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"name": "string",

  

"type": "string",

  

"subject": "string",

  

"body": "string",

  

"customSection1": "string",

  

"customSection2": "string",

  

"customSection3": "string",

  

"customSection4": "string"

}

Responses

POST

/api/v2/email-manager/

Playground

Authorization

bearerAuth

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

GET

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

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Send an Email

POST

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

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"to": "string",

  

"subject": "string",

  

"body": "string"

}

Responses

POST

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

Playground

Authorization

bearerAuth

Body

Samples

---

Create email template

POST

/api/v2/email-templates

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Email template created

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/email-templates

Playground

Authorization

bearerAuth

Body

Samples

---

Powered by VitePress OpenAPI