Open API v2 / Emails / Emails
Emails
→
Every request needs a bearer token: Authorization: Bearer <token>. Base URL https://your-site.webinone.com. New to field types? See the type reference.
Retrieves a list of emails by using a "where" filtering
Parameters
systemEventstring · queryrequired
SystemEvent.
Wherestring · query
JSON filter expression. Combine operators ($eq, $contains, $gt, $in, …) with $and / $or.
Order_Bystring · query
Sort field. Prefix with - for descending; comma-separate for tie-breakers.
Semantic_Querystring · query
Natural-language search, ranked by relevance.
Min_Scorenumber · query
Lowest relevance score to include when using Semantic_Query.
Offsetinteger · query
Number of items to skip before returning results. Defaults to 0.
Limitinteger · query
Maximum number of items to return. Defaults to 100.
Response
Idinteger
Unique identifier. Technical record number in the database. Read-only.
Namestring · nullable
Name of the email.
EmailTemplateIdinteger
The identifier of the visual framework (template) that defines the design (logos, footer, fonts).
FromNamestring · nullable
Sender display name.
FromEmailstring · nullable
The system address from which the letter originates.
Subjectstring · nullable
A message subject that clearly indicates the essence of the event.
Bodystring · nullable
Message body.
CreatedDateTimestring · date-time
Date and time of case creation in UTC. Read-only.
GroupNamestring · nullable
The name of the group or category to which this letter belongs.
curl "https://your-site.webinone.com/api/v2/admin/emails" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/emails", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/emails", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/emails', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/emails"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
{
"Items": [
{
"Id": 1,
"Name": "Example",
"EmailTemplateId": 1,
"FromName": "Example",
"FromEmail": "user@example.com",
"Subject": "string",
"Body": "string",
"CreatedDateTime": "2026-07-01T00: 00: 00Z",
"GroupName": "Example"
}
],
"TotalItemsCount": 0
}Creates a new email
Body parameters
EmailGroupTypeenumrequired
Specifies the category and purpose of the letter. Possible values: WorkflowNotification, FollowUpNotification, AbandonedCartNotification, RecurringReminderNotification.Possible values: WorkflowNotificationFollowUpNotificationAbandonedCartNotificationRecurringReminderNotification
Namestringrequired
Name of the email.
FromNamestringrequired
Sender display name.
FromEmailstringrequired
The system address from which the letter originates.
Subjectstringrequired
A message subject that clearly indicates the essence of the event.
EmailTemplateIdinteger
The identifier of the visual framework (template) that defines the design (logos, footer, fonts).
Bodystringrequired
Message body.
Response
Idinteger
Unique identifier. Technical record number in the database. Read-only.
Namestring · nullable
Name of the email.
EmailTemplateIdinteger
The identifier of the visual framework (template) that defines the design (logos, footer, fonts).
FromNamestring · nullable
Sender display name.
FromEmailstring · nullable
The system address from which the letter originates.
Subjectstring · nullable
A message subject that clearly indicates the essence of the event.
Bodystring · nullable
Message body.
CreatedDateTimestring · date-time
Date and time of case creation in UTC. Read-only.
GroupNamestring · nullable
The name of the group or category to which this letter belongs.
curl -X POST "https://your-site.webinone.com/api/v2/admin/emails" \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '{"EmailGroupType":"WorkflowNotification","Name":"Example","FromName":"Example","FromEmail":"user@example.com","Subject":"string","EmailTemplateId":1,"Body":"string"}'
await fetch("https://your-site.webinone.com/api/v2/admin/emails", { method: "POST", headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" }, body: JSON.stringify({ "EmailGroupType": "WorkflowNotification", "Name": "Example", "FromName": "Example", "FromEmail": "user@example.com", "Subject": "string", "EmailTemplateId": 1, "Body": "string" }) });
import requests requests.post( "https://your-site.webinone.com/api/v2/admin/emails", headers={"Authorization": "Bearer <token>"}, json={ "EmailGroupType": "WorkflowNotification", "Name": "Example", "FromName": "Example", "FromEmail": "user@example.com", "Subject": "string", "EmailTemplateId": 1, "Body": "string" } )
$client = new GuzzleHttp\Client(); $response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/emails', [ 'headers' => [ 'Authorization' => 'Bearer <token>', 'Content-Type' => 'application/json' ], 'json' => [ 'EmailGroupType' => 'WorkflowNotification', 'Name' => 'Example', 'FromName' => 'Example', 'FromEmail' => 'user@example.com', 'Subject' => 'string', 'EmailTemplateId' => 1, 'Body' => 'string' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/emails"); request.Headers.Add("Authorization", "Bearer <token>"); request.Content = new StringContent( "{\"EmailGroupType\":\"WorkflowNotification\",\"Name\":\"Example\",\"FromName\":\"Example\",\"FromEmail\":\"user@example.com\",\"Subject\":\"string\",\"EmailTemplateId\":1,\"Body\":\"string\"}", Encoding.UTF8, "application/json"); var response = await client.SendAsync(request);
Response · 200
{
"Id": 1,
"Name": "Example",
"EmailTemplateId": 1,
"FromName": "Example",
"FromEmail": "user@example.com",
"Subject": "string",
"Body": "string",
"CreatedDateTime": "2026-07-01T00: 00: 00Z",
"GroupName": "Example"
}Retrieves a single email
Parameters
idinteger · pathrequired
Email id.
Response
Idinteger
Unique identifier. Technical record number in the database. Read-only.
Namestring · nullable
Name of the email.
EmailTemplateIdinteger
The identifier of the visual framework (template) that defines the design (logos, footer, fonts).
FromNamestring · nullable
Sender display name.
FromEmailstring · nullable
The system address from which the letter originates.
Subjectstring · nullable
A message subject that clearly indicates the essence of the event.
Bodystring · nullable
Message body.
CreatedDateTimestring · date-time
Date and time of case creation in UTC. Read-only.
GroupNamestring · nullable
The name of the group or category to which this letter belongs.
curl "https://your-site.webinone.com/api/v2/admin/emails/1" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/emails/1", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/emails/1", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/emails/1', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/emails/1"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
{
"Id": 1,
"Name": "Example",
"EmailTemplateId": 1,
"FromName": "Example",
"FromEmail": "user@example.com",
"Subject": "string",
"Body": "string",
"CreatedDateTime": "2026-07-01T00: 00: 00Z",
"GroupName": "Example"
}Updates an existing email
Parameters
idinteger · pathrequired
Existent email id.
Body parameters
Namestringrequired
Name of the email update.
FromNamestringrequired
Sender display name.
FromEmailstringrequired
The system address from which the letter originates.
Subjectstringrequired
A message subject that clearly indicates the essence of the event.
EmailTemplateIdinteger
The identifier of the visual framework (template) that defines the design (logos, footer, fonts).
Bodystringrequired
Message body.
Response
Idinteger
Unique identifier. Technical record number in the database. Read-only.
Namestring · nullable
Name of the email.
EmailTemplateIdinteger
The identifier of the visual framework (template) that defines the design (logos, footer, fonts).
FromNamestring · nullable
Sender display name.
FromEmailstring · nullable
The system address from which the letter originates.
Subjectstring · nullable
A message subject that clearly indicates the essence of the event.
Bodystring · nullable
Message body.
CreatedDateTimestring · date-time
Date and time of case creation in UTC. Read-only.
GroupNamestring · nullable
The name of the group or category to which this letter belongs.
curl -X PUT "https://your-site.webinone.com/api/v2/admin/emails/1" \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '{"Name":"Example","FromName":"Example","FromEmail":"user@example.com","Subject":"string","EmailTemplateId":1,"Body":"string"}'
await fetch("https://your-site.webinone.com/api/v2/admin/emails/1", { method: "PUT", headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" }, body: JSON.stringify({ "Name": "Example", "FromName": "Example", "FromEmail": "user@example.com", "Subject": "string", "EmailTemplateId": 1, "Body": "string" }) });
import requests requests.put( "https://your-site.webinone.com/api/v2/admin/emails/1", headers={"Authorization": "Bearer <token>"}, json={ "Name": "Example", "FromName": "Example", "FromEmail": "user@example.com", "Subject": "string", "EmailTemplateId": 1, "Body": "string" } )
$client = new GuzzleHttp\Client(); $response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/emails/1', [ 'headers' => [ 'Authorization' => 'Bearer <token>', 'Content-Type' => 'application/json' ], 'json' => [ 'Name' => 'Example', 'FromName' => 'Example', 'FromEmail' => 'user@example.com', 'Subject' => 'string', 'EmailTemplateId' => 1, 'Body' => 'string' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/emails/1"); request.Headers.Add("Authorization", "Bearer <token>"); request.Content = new StringContent( "{\"Name\":\"Example\",\"FromName\":\"Example\",\"FromEmail\":\"user@example.com\",\"Subject\":\"string\",\"EmailTemplateId\":1,\"Body\":\"string\"}", Encoding.UTF8, "application/json"); var response = await client.SendAsync(request);
Response · 200
{
"Id": 1,
"Name": "Example",
"EmailTemplateId": 1,
"FromName": "Example",
"FromEmail": "user@example.com",
"Subject": "string",
"Body": "string",
"CreatedDateTime": "2026-07-01T00: 00: 00Z",
"GroupName": "Example"
}Deletes an existing email
Parameters
idinteger · pathrequired
Existent email id.
curl -X DELETE "https://your-site.webinone.com/api/v2/admin/emails/1" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/emails/1", { method: "DELETE", headers: { "Authorization": "Bearer <token>" } });
import requests requests.delete( "https://your-site.webinone.com/api/v2/admin/emails/1", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('DELETE', 'https://your-site.webinone.com/api/v2/admin/emails/1', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Delete, "https://your-site.webinone.com/api/v2/admin/emails/1"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Retrieves a list of email groups
Response
Idstring · nullable
Unique identifier. Technical record number in the database. Read-only.
Typestring · nullable
Machine key of the email group, identifying its category and purpose (for example WorkflowNotification or AbandonedCartNotification).
DisplayNamestring · nullable
Display name of the email group, shown to users.
curl "https://your-site.webinone.com/api/v2/admin/emails/custom-email-groups" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/emails/custom-email-groups", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/emails/custom-email-groups", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/emails/custom-email-groups', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/emails/custom-email-groups"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
[
{
"Id": "string",
"Type": "string",
"DisplayName": "Example"
}
]Retrieves a list of variables
Parameters
emailSectionstring · query
EmailSection.
Response
curl "https://your-site.webinone.com/api/v2/admin/emails/variables" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/emails/variables", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/emails/variables", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/emails/variables', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/emails/variables"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
[ "string" ]