Back

Search

Search

Methods

Inventory

Orders

Email /GenerateAdhocEmail

Response: GenerateAdhocEmailResponse



Generate a custom email

Parameters

NameTypeDescription
requestGenerateAdhocEmailRequestCustom email generation request body

HTTP Endpoint

Server /Email / GenerateAdhocEmail

Permissions

GlobalPermissions.Email.SendEmails.SendAdhocEmailsNode

Example Code

Example Request

The following request format is required for this method.

POST https://eu-ext.linnworks.net//api/Email/GenerateAdhocEmail HTTP/1.1
Host: eu-ext.linnworks.net
Connection: keep-alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.linnworks.net
Accept-Language: en
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.90 Safari/537.36
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Referer: https://www.linnworks.net/
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

request={
  "ids": [
    "3c8936bd-e255-45ba-b1fc-681f6e23aae9",
    "21fb395e-135a-483b-98ae-b9024898390e"
  ],
  "templateId": 1,
  "tags": [
    {
      "pkEmailStubTagId": 1,
      "fkEmailStubId": 2,
      "TagName": "sample string 3",
      "TagValue": "sample string 4"
    },
    {
      "pkEmailStubTagId": 1,
      "fkEmailStubId": 2,
      "TagName": "sample string 3",
      "TagValue": "sample string 4"
    }
  ],
  "attachments": [
    "sample string 1",
    "sample string 2"
  ]
}

Response

This is an example response. Results may vary depending on your data.

{
  "isComplete": true,
  "FailedRecipients": [
    "sample string 1",
    "sample string 2"
  ]
}