Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

Email /GenerateAdhocEmail

Allows 150 calls per minute

Response: GenerateAdhocEmailResponse



Generate a custom email

Parameters

NameTypeDescription
requestGenerateAdhocEmailRequestCustom email generation request body

Permissions

GlobalPermissions.Email.SendEmails.SendAdhocEmailsNode

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/Email/GenerateAdhocEmail

Headers

Connection: keep-alive
Accept: application/json
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

Request Body

This is an example of the request structure. Results will vary depending on your data.

request={
  "ids": [
    "e59c66e0-04ee-4bdd-ada4-4eed73209949"
  ],
  "templateId": 1,
  "tags": [
    {
      "pkEmailStubTagId": 1,
      "fkEmailStubId": 2,
      "TagName": "sample string 3",
      "TagValue": "sample string 4"
    }
  ],
  "attachments": [
    "sample string 1"
  ]
}

Response

This is an example of the response JSON. Results will vary depending on your data.

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