Zum Hauptinhalt gehen

Mail API

Um E-Mails über Quentn zu versenden, musst du die folgenden Schritte ausführen:

  • Erstelle eine E-Mail (optional mit Platzhaltern) und erhalte eine email_id
  • Stelle sicher, dass du mindestens einen Kontakt als Empfänger hast (verwende die Kontakt-API, um einen bestehenden Kontakt zu erstellen oder abzurufen)
  • Erhalte eine Absender_id (optional)
  • E-Mail senden

Create Email

Platzhalter
Du kannst die von der Quentn-Software angebotenen Platzhalter (meist beginnend mit {{contact:...}}) frei verwenden. Eine vollständige Liste aller Platzhalter findest du im E-Mail-Editor deiner Quentn-Software.

Darüber hinaus kannst du mit der Mail-API eigene Platzhalter für das Betreff- und das Textfeld definieren. Beim Versand von E-Mails über die API kannst du für jeden Empfänger entsprechende Ersetzungsdaten definieren. Die Platzhalter können beliebige UTF-8 Zeichen enthalten, z. B. %name% oder [first_name].

Request parameters

Name Type Required Description
subject String(255) yes Email subject
body_html String yes Email Html
body_text String no Raw text version of the email. If not defined, a text version will be created automatically from the given body_html.
context String(32) yes Context of the email. E.g. 'Opt-In' or 'Webinar Reminder'
sender_id Int no The default sender to use for this email

Request:

POST https://<system_id>.<server_id>.quentn.com/public/api/V1/mail/add HTTP/1.1


  {
   "subject" : "Welcome to my Newsletter",
   "body_html" : "<html><body><h1>Hello @name@, welcome to my Newsletter</h1>...",
   "body_text" : "Hello @name@, welcome to my Newsletter",
   "context" : "opt_in_mail"
  }

Response:


  {
    "id" : 1
  {

Retrieve Email

Nachdem du eine E-Mail erstellt hast, kannst du dich vergewissern, dass alles wie vorgesehen abgelaufen ist. Rufe dazu die E-Mail anhand ihrer Kennung auf, die du bei der Erstellung erhalten hast.

Request:

GET https://<system_id>.<server_id>.quentn.com/public/api/V1/mail/<email_id> HTTP/1.1

Response:


  {
   "id" : 1,
   "sender_id" : 1,
   "subject" : "Welcome to my Newsletter",
   "body_html" : "<html><body><h1>Hello @name@, welcome to my Newsletter</h1>...",
   "body_text" : "Hello @name@, welcome to my Newsletter",
   "context" : "opt_in_mail"
  }

Update Email

Request Parameters:

Name Type Required Description
subject String(255) no Email subject
body_html String no Email Html
body_text String no Raw text version of the email. If not defined, a text version will be created automatically from the given body_html.
context String(32) no Context of the email. E.g. 'Opt-In' or 'Webinar Reminder'
sender_id Int no The default sender to use for this email

Request:

PUT https://<system_id>.<server_id>.quentn.com/public/api/V1/mail/<email_id> HTTP/1.1


  {
   "sender_id" : 1,
   "subject" : "Welcome to my Newsletter",
   "body_html" : "<html><body><h1>Hello @name@, welcome to my Newsletter</h1>...",
   "body_text" : "Hello @name@, welcome to my Newsletter",
   "context" : "opt_in_mail"
  }

Response:


{
  "success": "true",
}

Delete Email

Request:

DELETE https://<system_id>.<server_id>.quentn.com/public/api/V1/mail/<email_id> HTTP/1.1

Response:


{
  "success": "true",
}

Get sender IDs

Rufe eine Liste der verfügbaren Absender ab. Bitte beachte, dass du nur bestätigte Absender erhältst.

Response parameters

Name Type Always included Description
id int yes Sender ID
email String yes Sender email address
first_name String no First name
last_name String no Last name
company Int no Company

Request:

GET https://<system_id>.<server_id>.quentn.com/public/api/V1/mail/senders HTTP/1.1

Response:


 [
   {
     "id" : 1,
     "email" : "johndoe@example.de",
     "first_name" : "John",
     "last_name" : "Doe",   
     "company" : "John Doe's Bikeshop Ltd."
   },
   {
     "id" : 2,
     "email" : "bikeshop@example.com"
   }
]

Send Email

Um eine E-Mail zu versenden, musst du eine E-Mail-ID und eine Liste von Empfängern angeben. Diese Liste enthält eine Kontakt-ID und, optional, Ersatzdaten für E-Mail-Platzhalter.

Bitte beachte: Jede Anfrage hat eine Höchstzahl von 1.000 Empfängern.

Request values:

Name Type Required Description
email_id int yes Email ID
recipients array yes List of recipients containing the recipient id and an optional list of field substitutions (see example below)
sender_id int no Sender id

Request:

POST https://<system_id>.<server_id>.quentn.com/public/api/V1/mail/<email_id>/send HTTP/1.1

Request data:


{
   'email_id' : 123,
   'recipients' : [
        {
           'id' : 1,
           'substitution_data' : {
                "@name@" : "John",
                 ....
            }
         },
         .....
    ]
}

Response:


{
  "success": "true",
}

 

Verwandte Beiträge