Open API v2 / Emails / Email Sender

Email Sender

→

Every request needs a bearer token: Authorization: Bearer <token>. Base URL https://your-site.webinone.com. New to field types? See the type reference.

POST/api/v2/admin/email-notification-sender/autoresponder#

Sends an autoresponder email notification

Body parameters

CaseIdintegerrequired

Identifier of the related case.

curl -X POST "https://your-site.webinone.com/api/v2/admin/email-notification-sender/autoresponder" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"CaseId":1}'

await fetch("https://your-site.webinone.com/api/v2/admin/email-notification-sender/autoresponder", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "CaseId": 1
  })
});

import requests

requests.post(
    "https://your-site.webinone.com/api/v2/admin/email-notification-sender/autoresponder",
    headers={"Authorization": "Bearer <token>"},
    json={
        "CaseId": 1
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/email-notification-sender/autoresponder', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'CaseId' => 1
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/email-notification-sender/autoresponder");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"CaseId\":1}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

POST/api/v2/admin/email-notification-sender/case#

Sends a case email notifications

Body parameters

CaseIdintegerrequired

Identifier of the related case.

curl -X POST "https://your-site.webinone.com/api/v2/admin/email-notification-sender/case" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"CaseId":1}'

await fetch("https://your-site.webinone.com/api/v2/admin/email-notification-sender/case", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "CaseId": 1
  })
});

import requests

requests.post(
    "https://your-site.webinone.com/api/v2/admin/email-notification-sender/case",
    headers={"Authorization": "Bearer <token>"},
    json={
        "CaseId": 1
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/email-notification-sender/case', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'CaseId' => 1
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/email-notification-sender/case");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"CaseId\":1}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

POST/api/v2/admin/email-notification-sender/confirm-email#

Sends a confirm email notification

Body parameters

Emailstringrequired

Email address.

curl -X POST "https://your-site.webinone.com/api/v2/admin/email-notification-sender/confirm-email" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"Email":"user@example.com"}'

await fetch("https://your-site.webinone.com/api/v2/admin/email-notification-sender/confirm-email", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "Email": "user@example.com"
  })
});

import requests

requests.post(
    "https://your-site.webinone.com/api/v2/admin/email-notification-sender/confirm-email",
    headers={"Authorization": "Bearer <token>"},
    json={
        "Email": "user@example.com"
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/email-notification-sender/confirm-email', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'Email' => 'user@example.com'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/email-notification-sender/confirm-email");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"Email\":\"user@example.com\"}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

POST/api/v2/admin/email-notification-sender/deferred-order-payment#

Sends a deferred order payment email notification

Body parameters

OrderIdintegerrequired

Identifier of the related order.

curl -X POST "https://your-site.webinone.com/api/v2/admin/email-notification-sender/deferred-order-payment" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"OrderId":1}'

await fetch("https://your-site.webinone.com/api/v2/admin/email-notification-sender/deferred-order-payment", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "OrderId": 1
  })
});

import requests

requests.post(
    "https://your-site.webinone.com/api/v2/admin/email-notification-sender/deferred-order-payment",
    headers={"Authorization": "Bearer <token>"},
    json={
        "OrderId": 1
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/email-notification-sender/deferred-order-payment', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'OrderId' => 1
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/email-notification-sender/deferred-order-payment");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"OrderId\":1}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

POST/api/v2/admin/email-notification-sender/gift-voucher#

Sends a gift voucher email notification

Body parameters

GiftVoucherIdintegerrequired

Identifier of the related gift voucher.

curl -X POST "https://your-site.webinone.com/api/v2/admin/email-notification-sender/gift-voucher" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"GiftVoucherId":1}'

await fetch("https://your-site.webinone.com/api/v2/admin/email-notification-sender/gift-voucher", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "GiftVoucherId": 1
  })
});

import requests

requests.post(
    "https://your-site.webinone.com/api/v2/admin/email-notification-sender/gift-voucher",
    headers={"Authorization": "Bearer <token>"},
    json={
        "GiftVoucherId": 1
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/email-notification-sender/gift-voucher', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'GiftVoucherId' => 1
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/email-notification-sender/gift-voucher");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"GiftVoucherId\":1}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

POST/api/v2/admin/email-notification-sender/invoice#

Sends an invoice email notification

Body parameters

OrderIdintegerrequired

Identifier of the related order.

curl -X POST "https://your-site.webinone.com/api/v2/admin/email-notification-sender/invoice" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"OrderId":1}'

await fetch("https://your-site.webinone.com/api/v2/admin/email-notification-sender/invoice", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "OrderId": 1
  })
});

import requests

requests.post(
    "https://your-site.webinone.com/api/v2/admin/email-notification-sender/invoice",
    headers={"Authorization": "Bearer <token>"},
    json={
        "OrderId": 1
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/email-notification-sender/invoice', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'OrderId' => 1
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/email-notification-sender/invoice");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"OrderId\":1}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

POST/api/v2/admin/email-notification-sender/low-stock#

Sends a low stock email notification

Body parameters

OrderIdintegerrequired

Identifier of the related order.

curl -X POST "https://your-site.webinone.com/api/v2/admin/email-notification-sender/low-stock" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"OrderId":1}'

await fetch("https://your-site.webinone.com/api/v2/admin/email-notification-sender/low-stock", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "OrderId": 1
  })
});

import requests

requests.post(
    "https://your-site.webinone.com/api/v2/admin/email-notification-sender/low-stock",
    headers={"Authorization": "Bearer <token>"},
    json={
        "OrderId": 1
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/email-notification-sender/low-stock', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'OrderId' => 1
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/email-notification-sender/low-stock");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"OrderId\":1}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

POST/api/v2/admin/email-notification-sender/module-item#

Sends a module item email notifications

Body parameters

Emailstringrequired

Email address.

ModuleItemIdintegerrequired

Identifier of the related module item.

EmailMessageEventenumrequired

The module item lifecycle event that the notification email is sent for. Determines which template placeholders are filled from the item's data. Possible values: None, ModuleItemCreated, ModuleItemUpdated, ModuleItemDeleted, ModuleItemUpdatedDraft, ModuleItemPublishedDraft.Possible values: NoneModuleItemCreatedModuleItemUpdatedModuleItemDeletedModuleItemUpdatedDraftModuleItemPublishedDraft

curl -X POST "https://your-site.webinone.com/api/v2/admin/email-notification-sender/module-item" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"Email":"user@example.com","ModuleItemId":1,"EmailMessageEvent":"None"}'

await fetch("https://your-site.webinone.com/api/v2/admin/email-notification-sender/module-item", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "Email": "user@example.com",
    "ModuleItemId": 1,
    "EmailMessageEvent": "None"
  })
});

import requests

requests.post(
    "https://your-site.webinone.com/api/v2/admin/email-notification-sender/module-item",
    headers={"Authorization": "Bearer <token>"},
    json={
        "Email": "user@example.com",
        "ModuleItemId": 1,
        "EmailMessageEvent": "None"
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/email-notification-sender/module-item', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'Email' => 'user@example.com',
        'ModuleItemId' => 1,
        'EmailMessageEvent' => 'None'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/email-notification-sender/module-item");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"Email\":\"user@example.com\",\"ModuleItemId\":1,\"EmailMessageEvent\":\"None\"}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

POST/api/v2/admin/email-notification-sender/password-retrieve-email#

Sends a password retrieve email notification

Body parameters

Emailstringrequired

Email address.

curl -X POST "https://your-site.webinone.com/api/v2/admin/email-notification-sender/password-retrieve-email" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"Email":"user@example.com"}'

await fetch("https://your-site.webinone.com/api/v2/admin/email-notification-sender/password-retrieve-email", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "Email": "user@example.com"
  })
});

import requests

requests.post(
    "https://your-site.webinone.com/api/v2/admin/email-notification-sender/password-retrieve-email",
    headers={"Authorization": "Bearer <token>"},
    json={
        "Email": "user@example.com"
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/email-notification-sender/password-retrieve-email', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'Email' => 'user@example.com'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/email-notification-sender/password-retrieve-email");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"Email\":\"user@example.com\"}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

POST/api/v2/admin/email-notification-sender/quote#

Sends a quote email notification

Body parameters

OrderIdintegerrequired

Identifier of the related order.

curl -X POST "https://your-site.webinone.com/api/v2/admin/email-notification-sender/quote" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"OrderId":1}'

await fetch("https://your-site.webinone.com/api/v2/admin/email-notification-sender/quote", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "OrderId": 1
  })
});

import requests

requests.post(
    "https://your-site.webinone.com/api/v2/admin/email-notification-sender/quote",
    headers={"Authorization": "Bearer <token>"},
    json={
        "OrderId": 1
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/email-notification-sender/quote', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'OrderId' => 1
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/email-notification-sender/quote");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"OrderId\":1}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

POST/api/v2/admin/email-notification-sender/restore-admin-user-password#

Sends a restore admin user password email notification

Body parameters

Emailstringrequired

Email address.

curl -X POST "https://your-site.webinone.com/api/v2/admin/email-notification-sender/restore-admin-user-password" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"Email":"user@example.com"}'

await fetch("https://your-site.webinone.com/api/v2/admin/email-notification-sender/restore-admin-user-password", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "Email": "user@example.com"
  })
});

import requests

requests.post(
    "https://your-site.webinone.com/api/v2/admin/email-notification-sender/restore-admin-user-password",
    headers={"Authorization": "Bearer <token>"},
    json={
        "Email": "user@example.com"
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/email-notification-sender/restore-admin-user-password', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'Email' => 'user@example.com'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/email-notification-sender/restore-admin-user-password");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"Email\":\"user@example.com\"}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

POST/api/v2/admin/email-notification-sender/secure-zone-login-details#

Sends a secure zone login details email notification

Body parameters

Emailstringrequired

Email address.

curl -X POST "https://your-site.webinone.com/api/v2/admin/email-notification-sender/secure-zone-login-details" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"Email":"user@example.com"}'

await fetch("https://your-site.webinone.com/api/v2/admin/email-notification-sender/secure-zone-login-details", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "Email": "user@example.com"
  })
});

import requests

requests.post(
    "https://your-site.webinone.com/api/v2/admin/email-notification-sender/secure-zone-login-details",
    headers={"Authorization": "Bearer <token>"},
    json={
        "Email": "user@example.com"
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/email-notification-sender/secure-zone-login-details', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'Email' => 'user@example.com'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/email-notification-sender/secure-zone-login-details");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"Email\":\"user@example.com\"}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

POST/api/v2/admin/email-notification-sender/supplier#

Sends a supplier email notification

Body parameters

OrderIdintegerrequired

Identifier of the related order.

curl -X POST "https://your-site.webinone.com/api/v2/admin/email-notification-sender/supplier" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"OrderId":1}'

await fetch("https://your-site.webinone.com/api/v2/admin/email-notification-sender/supplier", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "OrderId": 1
  })
});

import requests

requests.post(
    "https://your-site.webinone.com/api/v2/admin/email-notification-sender/supplier",
    headers={"Authorization": "Bearer <token>"},
    json={
        "OrderId": 1
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/email-notification-sender/supplier', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'OrderId' => 1
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/email-notification-sender/supplier");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"OrderId\":1}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

POST/api/v2/admin/email-notification-sender/workflows#

Sends a workflow email notification

Body parameters

CaseIdinteger

Identifier of the related case.

OrderIdinteger

Identifier of the related order.

CustomWorkflowIdsarray of integers

Identifiers of custom workflows to run alongside sending the email, such as changing an order status or creating a CRM task.

curl -X POST "https://your-site.webinone.com/api/v2/admin/email-notification-sender/workflows" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"CaseId":1,"OrderId":1,"CustomWorkflowIds":[0]}'

await fetch("https://your-site.webinone.com/api/v2/admin/email-notification-sender/workflows", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "CaseId": 1,
    "OrderId": 1,
    "CustomWorkflowIds": [
      0
    ]
  })
});

import requests

requests.post(
    "https://your-site.webinone.com/api/v2/admin/email-notification-sender/workflows",
    headers={"Authorization": "Bearer <token>"},
    json={
        "CaseId": 1,
        "OrderId": 1,
        "CustomWorkflowIds": [0]
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/email-notification-sender/workflows', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'CaseId' => 1,
        'OrderId' => 1,
        'CustomWorkflowIds' => [0]
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/email-notification-sender/workflows");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"CaseId\":1,\"OrderId\":1,\"CustomWorkflowIds\":[0]}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);