v12.11.0

V2 Staging API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

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

---

OutgoingEmailSettings

Outgoing email settings (mailer provider, credentials, from address)

Operations

GET/api/v2/settings/outgoing-emailPATCH/api/v2/settings/outgoing-email

---

Get outgoing email settings

GET

/api/v2/settings/outgoing-email

Returns the current outgoing email configuration including mailer type, from address, and provider credentials

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

Outgoing email settings

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/settings/outgoing-email

Playground

Authorization

bearerAuth

Samples

---

Update outgoing email settings

PATCH

/api/v2/settings/outgoing-email

Update outgoing email settings. Required fields depend on the selected mailer type.

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Updated outgoing email settings

Content-Type

application/json

{

  

"data": "string"

}

PATCH

/api/v2/settings/outgoing-email

Playground

Authorization

bearerAuth

Body

Samples

---

Powered by VitePress OpenAPI