Skip to content
/
Configure Newsletter Deli...

Configure Newsletter Delivery

Tool name: configure-newsletter-delivery

Writes the delivery configuration of an email newsletter in KlickTipp: sender name, sender address, reply address, sending domain and signature. Reports back what is still missing before the newsletter could be sent, together with the sender addresses, sending domains and signatures the account may use. Concrete sender addresses are checked against their live verified domains; changing the address also derives and stores its matching domain. The sender and domain dispatch-profile sources are selected together. This tool neither schedules nor activates anything and reaches no recipient -- activation is a separate tool. Arguments that are left out keep their current value. Only a newsletter that was never scheduled can be configured: any other lifecycle state is refused before anything is written.

Input schema

newsletterIdinteger, >= 1required

ID of the newsletter to configure

senderNameModenull or string

"explicit" (pass senderName), "account_default" or "signature_dispatch_profile"; omit to keep

Default:null
Enum:"explicit""account_default""signature_dispatch_profile"
senderNamenull or string, <= 250 characters

Name the recipients see as the sender, for mode "explicit" only; omit to keep the current one

Default:null
senderEmailModenull or string

"explicit" (pass senderEmail), "account_default" or "signature_dispatch_profile"; omit to keep

Default:null
Enum:"explicit""account_default""signature_dispatch_profile"
senderEmailnull or string, <= 250 characters

Sender address configured for the account; for mode "explicit"; omit to keep

Default:null
replyToEmailModenull or string

"explicit" (pass replyToEmail), "account_default" or "signature_dispatch_profile"; omit to keep

Default:null
Enum:"explicit""account_default""signature_dispatch_profile"
replyToEmailnull or string, <= 250 characters

Address answers go to, for mode "explicit" only; omit to keep the current one

Default:null
senderDomainModenull or string

"explicit" (pass senderDomain), "account_default" for automatic resolution or "signature_dispatch_profile"; omit to keep

Default:null
Enum:"explicit""account_default""signature_dispatch_profile"
senderDomainnull or string, <= 250 characters

Matching verified domain; for mode "explicit"; omit to derive it when changing the sender address

Default:null
signatureIdnull or integer, >= 0

ID of the signature under the newsletter; 0 lets KlickTipp pick one by tagging; omit to keep

Default:null
linkTrackingnull or boolean

Whether KlickTipp rewrites the links so clicks are counted; true is the normal case, omit to keep

Default:null
accountIdnull or integer, >= 1

User ID of the account; omit for the account the access token works in

Default:null
Input example
{
  "newsletterId": 1,
  "senderNameMode": "explicit",
  "senderName": null,
  "senderEmailMode": "explicit",
  "senderEmail": null,
  "replyToEmailMode": "explicit",
  "replyToEmail": null,
  "senderDomainMode": "explicit",
  "senderDomain": null,
  "signatureId": null,
  "linkTracking": null,
  "headerLinks": null,
  "accountId": null
}

Output schema

accountIdintegerrequired
newsletterIdintegerrequired
emailIdintegerrequired
namestringrequired
newsletterStatusstringrequired
senderobjectrequired
trackingobjectrequired
missingRequirementsArray of stringsrequired
readyToSendbooleanrequired
availableSenderAddressesArray of stringsrequired
availableSenderDomainsArray of stringsrequired
availableSignaturesArray of objectsrequired
contentUrlstringrequired
scheduleUrlstringrequired
Output example
{
  "accountId": 0,
  "newsletterId": 0,
  "emailId": 0,
  "name": "string",
  "newsletterStatus": "string",
  "sender": {
    "senderNameMode": "string",
    "senderName": "string",
    "senderEmailMode": "string",
    "senderEmail": "string",
    "replyToEmailMode": "string",
    "replyToEmail": "string",
    "senderDomainMode": "string",
    "senderDomain": "string",
    "signature": {
      "mode": "string",
      "id": 0,
      "name": "string"
    }
  },
  "tracking": {
    "linkTracking": true,
    "headerLinks": true,
    "linkTrackingCanBeTurnedOff": true
  },
  "missingRequirements": [
    "string"
  ],
  "readyToSend": true,
  "availableSenderAddresses": [
    "string"
  ],
  "availableSenderDomains": [
    "string"
  ],
  "availableSignatures": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "contentUrl": "string",
  "scheduleUrl": "string"
}