E-mailová šablóna API

Správa e-mailových šablón — načítanie, vytvorenie, úprava a odstránenie

Základná URL

https://{tenant}.logzi.com/api/email_template/

Každá požiadavka vracia JSON odpoveď. Pri úspešnej odpovedi je result.code == 1, pri chybe result.code == 0. E-mailové šablóny obsahujú predmet a HTML obsah — pri odosielaní dokladu ich systém automaticky vyplní.

GET /api/email_template/get

Načítanie jednej e-mailovej šablóny podľa identifikátora.

Query parametre

ParameterTypPovinnéPopis
idintIdentifikátor e-mailovej šablóny

Príklad požiadavky

GET /api/email_template/get?id=2
X-API-KEY: {vas_api_kluc}
GET /api/email_template/list

Načítanie stránkovateľného zoznamu e-mailových šablón.

Query parametre

ParameterTypPovinnéPopis
list_offsetintPosun stránkovania (predvolené: 0)
list_conditionobjectObjekt s filtračnými podmienkami

Príklad požiadavky

GET /api/email_template/list?list_offset=0
X-API-KEY: {vas_api_kluc}
POST /api/email_template/save

Vytvorenie alebo úprava e-mailovej šablóny. Pre novú šablónu data[id] = 0.

POST polia — objekt data

PoleTypPovinnéPopis
idint0 = nová šablóna, >0 = úprava
company_user_idintIdentifikátor zamestnanca — vlastníka šablóny
email_template_namestringNázov šablóny (pre internú identifikáciu)
template_subjectstringPredmet e-mailu (dynamické tagy podporované)
template_contentstringHTML telo textu (dynamické tagy podporované)
email_template_type_idintIdentifikátor typu šablóny
email_template_ccstringE-mailová adresa (adresy) v kópii (CC)
template_enable_item_file_list_tableint1 = tabuľka príloh je vložená

Príklad požiadavky

POST /api/email_template/save
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "company_user_id": 3,
    "email_template_name": "Számla kiküldő sablon",
    "template_subject": "Számla: {identify}",
    "template_content": "<p>Kedves {partner_name},</p><p>mellékeljük a számlát.</p>"
  }
}
POST /api/email_template/delete

Odstránenie e-mailovej šablóny podľa identifikátora.

POST polia — objekt data

PoleTypPovinnéPopis
idintIdentifikátor šablóny, ktorá sa má odstrániť

Príklad požiadavky

POST /api/email_template/delete
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{ "data": { "id": 2 } }

Kontaktuj nás

Zaujíma ťa náš softvér? Pokojne nám napíš!

Potrebuješ pomoc?

Ak nevieš nájsť odpoveď a potrebuješ pomoc

Zaregistruj sa teraz,
zaplať neskôr!

Vyskúšaj 3 dni zadarmo, bez rizika a záväzkov!