title | keywords | last_updated | tags | summary |
---|---|---|---|---|
AWS Simple Email Service endpoint |
May 9, 2023 |
Detailed description of the API of the AWS Simple Email Service endpoint. |
The AWS Simple Email Service endpoint has the following features:
- Authentication
- Automatic signing of request
- Helpers to use the REST API
Please make sure you take a look at the documentation from AWS Simple Email Service as features are based on its API:
First of all you will need to create an instance for AWS Connect. Once you have created it and the endpoint is configured, you can start making calls to the API.
After you configure the key and secret you can use the helpers to send an email.
// Sending email using helper
var res = app.endpoints.awsSes.SendEmail({
'Destination.ToAddresses.member.1': 'demo@domain.com',
'Message.Subject.Data': 'Test message',
'Message.Body.Text.Data': 'Hello. I hope you are having a good day!',
'Source': 'from@domain.com'
});
log(JSON.stringify(res));
var res = app.endpoints.awsSes.SendEmail({
'Destination': {
'ToAddresses': {
'member': ['demo@domain.com', 'demo2@domain.com']
}
},
'Message': {
'Subject':{
'Data': 'Test Message'
},
'Body': {
'Text': {
'Data': 'Hello. I hope you are having a good day!'
}
}
},
'Source': 'from@domain.com'
});
log(JSON.stringify(res));
Or you can retrieve the identities list:
var res = app.endpoints.awsSes.ListIdentities();
log(JSON.stringify(res));
In order to configure the endpoint, you previously need to have an AWS account and an instance created for AWS Connect.
The access key for the user making the calls. Make sure the user has access to your AWS Connect instance.
The secret access key for the user making the calls. Make sure the user has access to your AWS Connect instance.
The region where your AWS Connect instance was created. For example us-east-1
.
The endpoint provides methods to access all methods in the REST API. Here is a list of the available methods in the API, but you should check AWS Simple Email Service documentation for more information:
endpoint.awsses.CloneReceiptRuleSet(requestParameters);
endpoint.awsses.CreateConfigurationSet(requestParameters);
endpoint.awsses.CreateConfigurationSetEventDestination(requestParameters);
endpoint.awsses.CreateConfigurationSetTrackingOptions(requestParameters);
endpoint.awsses.CreateCustomVerificationEmailTemplate(requestParameters);
endpoint.awsses.CreateReceiptFilter(requestParameters);
endpoint.awsses.CreateReceiptRule(requestParameters);
endpoint.awsses.CreateReceiptRuleSet(requestParameters);
endpoint.awsses.CreateTemplate(requestParameters);
endpoint.awsses.DeleteConfigurationSet(requestParameters);
endpoint.awsses.DeleteConfigurationSetEventDestination(requestParameters);
endpoint.awsses.DeleteConfigurationSetTrackingOptions(requestParameters);
endpoint.awsses.DeleteCustomVerificationEmailTemplate(requestParameters);
endpoint.awsses.DeleteIdentity(requestParameters);
endpoint.awsses.DeleteIdentityPolicy(requestParameters);
endpoint.awsses.DeleteReceiptFilter(requestParameters);
endpoint.awsses.DeleteReceiptRule(requestParameters);
endpoint.awsses.DeleteReceiptRuleSet(requestParameters);
endpoint.awsses.DeleteTemplate(requestParameters);
endpoint.awsses.DeleteVerifiedEmailAddress(requestParameters);
endpoint.awsses.DescribeActiveReceiptRuleSet(requestParameters);
endpoint.awsses.DescribeConfigurationSet(requestParameters);
endpoint.awsses.DescribeReceiptRule(requestParameters);
endpoint.awsses.DescribeReceiptRuleSet(requestParameters);
endpoint.awsses.GetAccountSendingEnabled(requestParameters);
endpoint.awsses.GetCustomVerificationEmailTemplate(requestParameters);
endpoint.awsses.GetIdentityDkimAttributes(requestParameters);
endpoint.awsses.GetIdentityMailFromDomainAttributes(requestParameters);
endpoint.awsses.GetIdentityNotificationAttributes(requestParameters);
endpoint.awsses.GetIdentityPolicies(requestParameters);
endpoint.awsses.GetIdentityVerificationAttributes(requestParameters);
endpoint.awsses.GetSendQuota(requestParameters);
endpoint.awsses.GetSendStatistics(requestParameters);
endpoint.awsses.GetTemplate(requestParameters);
endpoint.awsses.ListConfigurationSets(requestParameters);
endpoint.awsses.ListCustomVerificationEmailTemplates(requestParameters);
endpoint.awsses.ListIdentities(requestParameters);
endpoint.awsses.ListIdentityPolicies(requestParameters);
endpoint.awsses.ListReceiptFilters(requestParameters);
endpoint.awsses.ListReceiptRuleSets(requestParameters);
endpoint.awsses.ListTemplates(requestParameters);
endpoint.awsses.ListVerifiedEmailAddresses(requestParameters);
endpoint.awsses.PutIdentityPolicy(requestParameters);
endpoint.awsses.ReorderReceiptRuleSet(requestParameters);
endpoint.awsses.SendBounce(requestParameters);
endpoint.awsses.SendBulkTemplatedEmail(requestParameters);
endpoint.awsses.SendCustomVerificationEmail(requestParameters);
endpoint.awsses.SendEmail(requestParameters);
endpoint.awsses.SendRawEmail(requestParameters);
endpoint.awsses.SendTemplatedEmail(requestParameters);
endpoint.awsses.SetActiveReceiptRuleSet(requestParameters);
endpoint.awsses.SetIdentityDkimEnabled(requestParameters);
endpoint.awsses.SetIdentityFeedbackForwardingEnabled(requestParameters);
endpoint.awsses.SetIdentityHeadersInNotificationsEnabled(requestParameters);
endpoint.awsses.SetIdentityMailFromDomain(requestParameters);
endpoint.awsses.SetIdentityNotificationTopic(requestParameters);
endpoint.awsses.SetReceiptRulePosition(requestParameters);
endpoint.awsses.TestRenderTemplate(requestParameters);
endpoint.awsses.UpdateAccountSendingEnabled(requestParameters);
endpoint.awsses.UpdateConfigurationSetEventDestination(requestParameters);
endpoint.awsses.UpdateConfigurationSetReputationMetricsEnabled(requestParameters);
endpoint.awsses.UpdateConfigurationSetSendingEnabled(requestParameters);
endpoint.awsses.UpdateConfigurationSetTrackingOptions(requestParameters);
endpoint.awsses.UpdateCustomVerificationEmailTemplate(requestParameters);
endpoint.awsses.UpdateReceiptRule(requestParameters);
endpoint.awsses.UpdateTemplate(requestParameters);
endpoint.awsses.VerifyDomainDkim(requestParameters);
endpoint.awsses.VerifyDomainIdentity(requestParameters);
endpoint.awsses.VerifyEmailAddress(requestParameters);
endpoint.awsses.VerifyEmailIdentity(requestParameters);
The Javascript API of the awsSes endpoint has three pieces:
- HTTP requests: These allow to make regular HTTP requests.
- Shortcuts: These are helpers to make HTTP request to the API in a more convenient way.
- Additional Helpers: These helpers provide additional features that facilitate or improves the endpoint usage in SLINGR.
You can make POST
,DELETE
,GET
,PUT
requests to the awsSes API like this:
var response = app.endpoints.awsSes.post('/v2/email/outbound-emails', body)
var response = app.endpoints.awsSes.post('/v2/email/outbound-emails')
var response = app.endpoints.awsSes.delete('/v2/email/templates/:TemplateName')
var response = app.endpoints.awsSes.get('/v2/email/deliverability-dashboard')
var response = app.endpoints.awsSes.put('/v2/email/configuration-sets/:ConfigurationSetName/tracking-options', body)
var response = app.endpoints.awsSes.put('/v2/email/configuration-sets/:ConfigurationSetName/tracking-options')
Please take a look at the documentation of the HTTP endpoint for more information about generic requests.
Instead of having to use the generic HTTP methods, you can (and should) make use of the helpers provided in the endpoint:
Click here to see all the helpers
- API URL: '/v2/email/metrics/batch'
- HTTP Method: 'POST'
app.endpoints.awsSes.email.metrics.batch.post(body)
- API URL: '/v2/email/configuration-sets'
- HTTP Method: 'POST'
app.endpoints.awsSes.email.configurationSets.post(body)
- API URL: '/v2/email/configuration-sets/:ConfigurationSetName/event-destinations'
- HTTP Method: 'POST'
app.endpoints.awsSes.email.configurationSets.eventDestinations.post(ConfigurationSetName, body)
- API URL: '/v2/email/contact-lists/:ContactListName/contacts'
- HTTP Method: 'POST'
app.endpoints.awsSes.email.contactLists.contacts.post(ContactListName, body)
- API URL: '/v2/email/contact-lists'
- HTTP Method: 'POST'
app.endpoints.awsSes.email.contactLists.post(body)
- API URL: '/v2/email/custom-verification-email-templates'
- HTTP Method: 'POST'
app.endpoints.awsSes.email.customVerificationEmailTemplates.post(body)
- API URL: '/v2/email/dedicated-ip-pools'
- HTTP Method: 'POST'
app.endpoints.awsSes.email.dedicatedIpPools.post(body)
- API URL: '/v2/email/deliverability-dashboard/test'
- HTTP Method: 'POST'
app.endpoints.awsSes.email.deliverabilityDashboard.test.post(body)
- API URL: '/v2/email/identities'
- HTTP Method: 'POST'
app.endpoints.awsSes.email.identities.post(body)
- API URL: '/v2/email/identities/:EmailIdentity/policies/:PolicyName'
- HTTP Method: 'POST'
app.endpoints.awsSes.email.identities.policies.post(EmailIdentity, PolicyName, body)
- API URL: '/v2/email/templates'
- HTTP Method: 'POST'
app.endpoints.awsSes.email.templates.post(body)
- API URL: '/v2/email/import-jobs'
- HTTP Method: 'POST'
app.endpoints.awsSes.email.importJobs.post(body)
- API URL: '/v2/email/vdm/recommendations'
- HTTP Method: 'POST'
app.endpoints.awsSes.email.vdm.recommendations.post(body)
- API URL: '/v2/email/account/details'
- HTTP Method: 'POST'
app.endpoints.awsSes.email.account.details.post(body)
- API URL: '/v2/email/outbound-custom-verification-emails'
- HTTP Method: 'POST'
app.endpoints.awsSes.email.outboundCustomVerificationEmails.post(body)
- API URL: '/v2/email/outbound-emails'
- HTTP Method: 'POST'
app.endpoints.awsSes.email.outboundEmails.post(body)
- API URL: '/v2/email/tags'
- HTTP Method: 'POST'
app.endpoints.awsSes.email.tags.post(body)
- API URL: '/v2/email/templates/:TemplateName/render'
- HTTP Method: 'POST'
app.endpoints.awsSes.email.templates.render.post(TemplateName, body)
- API URL: '/v2/email/configuration-sets/:ConfigurationSetName'
- HTTP Method: 'DELETE'
app.endpoints.awsSes.email.configurationSets.delete(ConfigurationSetName)
- API URL: '/v2/email/configuration-sets/:ConfigurationSetName/eventdestinations/:EventDestinationName'
- HTTP Method: 'DELETE'
app.endpoints.awsSes.email.configurationSets.eventdestinations.delete(ConfigurationSetName, EventDestinationName)
- API URL: '/v2/email/contact-lists/:ContactListName/contacts/:EmailAddress'
- HTTP Method: 'DELETE'
app.endpoints.awsSes.email.contactLists.contacts.delete(ContactListName, EmailAddress)
- API URL: '/v2/email/contact-lists/:ContactListName'
- HTTP Method: 'DELETE'
app.endpoints.awsSes.email.contactLists.delete(ContactListName)
- API URL: '/v2/email/custom-verification-email-templates/:TemplateName'
- HTTP Method: 'DELETE'
app.endpoints.awsSes.email.customVerificationEmailTemplates.delete(TemplateName)
- API URL: '/v2/email/dedicated-ip-pools/:PoolName'
- HTTP Method: 'DELETE'
app.endpoints.awsSes.email.dedicatedIpPools.delete(PoolName)
- API URL: '/v2/email/identities/:EmailIdentity'
- HTTP Method: 'DELETE'
app.endpoints.awsSes.email.identities.delete(EmailIdentity)
- API URL: '/v2/email/identities/:EmailIdentity/policies/:PolicyName'
- HTTP Method: 'DELETE'
app.endpoints.awsSes.email.identities.policies.delete(EmailIdentity, PolicyName)
- API URL: '/v2/email/templates/:TemplateName'
- HTTP Method: 'DELETE'
app.endpoints.awsSes.email.templates.delete(TemplateName)
- API URL: '/v2/email/suppression/addresses/:EmailAddress'
- HTTP Method: 'DELETE'
app.endpoints.awsSes.email.suppression.addresses.delete(EmailAddress)
- API URL: '/v2/email/tags'
- HTTP Method: 'DELETE'
app.endpoints.awsSes.email.tags.delete()
- API URL: '/v2/email/account'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.account.get()
- API URL: '/v2/email/deliverability-dashboard/blacklist-report'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.deliverabilityDashboard.blacklistReport.get()
- API URL: '/v2/email/configuration-sets/ConfigurationSetName'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.configurationSets.ConfigurationSetName.get()
- API URL: '/v2/email/configuration-sets/:ConfigurationSetName/event-destinations'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.configurationSets.eventDestinations.get(ConfigurationSetName)
- API URL: '/v2/email/contact-lists/:ContactListName/contacts/:EmailAddress'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.contactLists.contacts.get(ContactListName)
- API URL: '/v2/email/contact-lists/:ContactListName/contacts'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.contactLists.contacts.get()
- API URL: '/v2/email/contact-lists/:ContactListName'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.contactLists.get()
- API URL: '/v2/email/contact-lists'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.contactLists.get()
- API URL: '/v2/email/custom-verification-email-templates/:TemplateName'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.customVerificationEmailTemplates.get()
- API URL: '/v2/email/custom-verification-email-templates'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.customVerificationEmailTemplates.get()
- API URL: '/v2/email/dedicated-ips/:IP'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.dedicatedIps.get()
- API URL: '/v2/email/dedicated-ips'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.dedicatedIps.get()
- API URL: '/v2/email/dedicated-ip-pools/:PoolName'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.dedicatedIpPools.get()
- API URL: '/v2/email/dedicated-ip-pools'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.dedicatedIpPools.get()
- API URL: '/v2/email/deliverability-dashboard'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.deliverabilityDashboard.get()
- API URL: '/v2/email/deliverability-dashboard/test-reports/:ReportId'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.deliverabilityDashboard.testReports.get()
- API URL: '/v2/email/deliverability-dashboard/test-reports'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.deliverabilityDashboard.testReports.get()
- API URL: '/v2/email/deliverability-dashboard/campaigns/:CampaignId'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.deliverabilityDashboard.campaigns.get(CampaignId)
- API URL: '/v2/email/deliverability-dashboard/statistics-report/:Domain'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.deliverabilityDashboard.statisticsReport.get(Domain)
- API URL: '/v2/email/identities/:EmailIdentity'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.identities.get()
- API URL: '/v2/email/identities'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.identities.get()
- API URL: '/v2/email/identities/:EmailIdentity/policies'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.identities.policies.get(EmailIdentity)
- API URL: '/v2/email/templates/:TemplateName'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.templates.get()
- API URL: '/v2/email/templates'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.templates.get()
- API URL: '/v2/email/import-jobs/:JobId'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.importJobs.get()
- API URL: '/v2/email/import-jobs'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.importJobs.get()
- API URL: '/v2/email/suppression/addresses/:EmailAddress'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.suppression.addresses.get()
- API URL: '/v2/email/suppression/addresses'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.suppression.addresses.get()
- API URL: '/v2/email/configuration-sets'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.configurationSets.get()
- API URL: '/v2/email/deliverability-dashboard/domains/:SubscribedDomain/campaigns'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.deliverabilityDashboard.domains.campaigns.get(SubscribedDomain)
- API URL: '/v2/email/tags'
- HTTP Method: 'GET'
app.endpoints.awsSes.email.tags.get()
- API URL: '/v2/email/account/dedicated-ips/warmup'
- HTTP Method: 'PUT'
app.endpoints.awsSes.email.account.dedicatedIps.warmup.put(body)
- API URL: '/v2/email/account/sending'
- HTTP Method: 'PUT'
app.endpoints.awsSes.email.account.sending.put(body)
- API URL: '/v2/email/account/suppression'
- HTTP Method: 'PUT'
app.endpoints.awsSes.email.account.suppression.put(body)
- API URL: '/v2/email/account/vdm'
- HTTP Method: 'PUT'
app.endpoints.awsSes.email.account.vdm.put(body)
- API URL: '/v2/email/configuration-sets/:ConfigurationSetName/delivery-options'
- HTTP Method: 'PUT'
app.endpoints.awsSes.email.configurationSets.deliveryOptions.put(ConfigurationSetName, body)
- API URL: '/v2/email/configuration-sets/:ConfigurationSetName/reputation-options'
- HTTP Method: 'PUT'
app.endpoints.awsSes.email.configurationSets.reputationOptions.put(ConfigurationSetName, body)
- API URL: '/v2/email/configuration-sets/:ConfigurationSetName/sending'
- HTTP Method: 'PUT'
app.endpoints.awsSes.email.configurationSets.sending.put(ConfigurationSetName, body)
- API URL: '/v2/email/configuration-sets/:ConfigurationSetName/suppression-options'
- HTTP Method: 'PUT'
app.endpoints.awsSes.email.configurationSets.suppressionOptions.put(ConfigurationSetName, body)
- API URL: '/v2/email/configuration-sets/:ConfigurationSetName/tracking-options'
- HTTP Method: 'PUT'
app.endpoints.awsSes.email.configurationSets.trackingOptions.put(ConfigurationSetName, body)
- API URL: '/v2/email/configuration-sets/:ConfigurationSetName/vdm-options'
- HTTP Method: 'PUT'
app.endpoints.awsSes.email.configurationSets.vdmOptions.put(ConfigurationSetName, body)
- API URL: '/v2/email/dedicated-ips/:IP/pool'
- HTTP Method: 'PUT'
app.endpoints.awsSes.email.dedicatedIps.pool.put(IP, body)
- API URL: '/v2/email/dedicated-ips/:IP/warmup'
- HTTP Method: 'PUT'
app.endpoints.awsSes.email.dedicatedIps.warmup.put(IP, body)
- API URL: '/v2/email/deliverability-dashboard'
- HTTP Method: 'PUT'
app.endpoints.awsSes.email.deliverabilityDashboard.put(body)
- API URL: '/v2/email/identities/:EmailIdentity/configuration-set'
- HTTP Method: 'PUT'
app.endpoints.awsSes.email.identities.configurationSet.put(EmailIdentity, body)
- API URL: '/v2/email/identities/:EmailIdentity/dkim'
- HTTP Method: 'PUT'
app.endpoints.awsSes.email.identities.dkim.put(EmailIdentity, body)
- API URL: '/v1/email/identities/EmailIdentity/dkim/signing'
- HTTP Method: 'PUT'
app.endpoints.awsSes.email.identities.EmailIdentity.dkim.signing.put(body)
- API URL: '/v2/email/identities/:EmailIdentity/feedback'
- HTTP Method: 'PUT'
app.endpoints.awsSes.email.identities.feedback.put(EmailIdentity, body)
- API URL: '/v2/email/identities/:EmailIdentity/mail-from'
- HTTP Method: 'PUT'
app.endpoints.awsSes.email.identities.mailFrom.put(EmailIdentity, body)
- API URL: '/v2/email/suppression/addresses'
- HTTP Method: 'PUT'
app.endpoints.awsSes.email.suppression.addresses.put(body)
- API URL: '/v2/email/outbound-bulk-emails'
- HTTP Method: 'PUT'
app.endpoints.awsSes.email.outboundBulkEmails.put(body)
- API URL: '/v2/email/configuration-sets/:ConfigurationSetName/eventdestinations/:EventDestinationName'
- HTTP Method: 'PUT'
app.endpoints.awsSes.email.configurationSets.eventdestinations.put(ConfigurationSetName, EventDestinationName, body)
- API URL: '/v2/email/contact-lists/:ContactListName/contacts/:EmailAddress'
- HTTP Method: 'PUT'
app.endpoints.awsSes.email.contactLists.contacts.put(ContactListName, EmailAddress, body)
- API URL: '/v2/email/contact-lists/:ContactListName'
- HTTP Method: 'PUT'
app.endpoints.awsSes.email.contactLists.put(ContactListName, body)
- API URL: '/v2/email/custom-verification-email-templates/:TemplateName'
- HTTP Method: 'PUT'
app.endpoints.awsSes.email.customVerificationEmailTemplates.put(TemplateName, body)
- API URL: '/v2/email/identities/:EmailIdentity/policies/:PolicyName'
- HTTP Method: 'PUT'
app.endpoints.awsSes.email.identities.policies.put(EmailIdentity, PolicyName, body)
- API URL: '/v2/email/templates/:TemplateName'
- HTTP Method: 'PUT'
app.endpoints.awsSes.email.templates.put(TemplateName, body)
As an alternative option to using scripts, you can make use of Flows and Flow Steps specifically created for the endpoint:
Click here to see the Flow Steps
Generic flow step for full use of the entire endpoint and its services.
Label | Type | Required | Default | Visibility | Description |
---|---|---|---|---|---|
URL (Method) | choice | yes | - | Always |
This is the http method to be used against the endpoint. Possible values are: POST,DELETE,GET,PUT |
URL (Path) | choice | yes | - | Always |
The url to which this endpoint will send the request. This is the exact service to which the http request will be made. Possible values are: /v2/email/metrics/batch /v2/email/configuration-sets /v2/email/configuration-sets/{ConfigurationSetName}/event-destinations /v2/email/contact-lists/{ContactListName}/contacts /v2/email/contact-lists /v2/email/custom-verification-email-templates /v2/email/dedicated-ip-pools /v2/email/deliverability-dashboard/test /v2/email/identities /v2/email/identities/{EmailIdentity}/policies/{PolicyName} /v2/email/templates /v2/email/import-jobs /v2/email/vdm/recommendations /v2/email/account/details /v2/email/outbound-custom-verification-emails /v2/email/outbound-emails /v2/email/tags /v2/email/templates/{TemplateName}/render /v2/email/configuration-sets/{ConfigurationSetName} /v2/email/configuration-sets/{ConfigurationSetName}/eventdestinations/{EventDestinationName} /v2/email/contact-lists/{ContactListName}/contacts/{EmailAddress} /v2/email/contact-lists/{ContactListName} /v2/email/custom-verification-email-templates/{TemplateName} /v2/email/dedicated-ip-pools/{PoolName} /v2/email/identities/{EmailIdentity} /v2/email/identities/{EmailIdentity}/policies/{PolicyName} /v2/email/templates/{TemplateName} /v2/email/suppression/addresses/{EmailAddress} /v2/email/tags /v2/email/account /v2/email/deliverability-dashboard/blacklist-report /v2/email/configuration-sets/ConfigurationSetName /v2/email/configuration-sets/{ConfigurationSetName}/event-destinations /v2/email/contact-lists/{ContactListName}/contacts/{EmailAddress} /v2/email/contact-lists/{ContactListName}/contacts /v2/email/contact-lists/{ContactListName} /v2/email/contact-lists /v2/email/custom-verification-email-templates/{TemplateName} /v2/email/custom-verification-email-templates /v2/email/dedicated-ips/{IP} /v2/email/dedicated-ips /v2/email/dedicated-ip-pools/{PoolName} /v2/email/dedicated-ip-pools /v2/email/deliverability-dashboard /v2/email/deliverability-dashboard/test-reports/{ReportId} /v2/email/deliverability-dashboard/test-reports /v2/email/deliverability-dashboard/campaigns/{CampaignId} /v2/email/deliverability-dashboard/statistics-report/{Domain} /v2/email/identities/{EmailIdentity} /v2/email/identities /v2/email/identities/{EmailIdentity}/policies /v2/email/templates/{TemplateName} /v2/email/templates /v2/email/import-jobs/{JobId} /v2/email/import-jobs /v2/email/suppression/addresses/{EmailAddress} /v2/email/suppression/addresses /v2/email/configuration-sets /v2/email/deliverability-dashboard/domains/{SubscribedDomain}/campaigns /v2/email/tags /v2/email/account/dedicated-ips/warmup /v2/email/account/sending /v2/email/account/suppression /v2/email/account/vdm /v2/email/configuration-sets/{ConfigurationSetName}/delivery-options /v2/email/configuration-sets/{ConfigurationSetName}/reputation-options /v2/email/configuration-sets/{ConfigurationSetName}/sending /v2/email/configuration-sets/{ConfigurationSetName}/suppression-options /v2/email/configuration-sets/{ConfigurationSetName}/tracking-options /v2/email/configuration-sets/{ConfigurationSetName}/vdm-options /v2/email/dedicated-ips/{IP}/pool /v2/email/dedicated-ips/{IP}/warmup /v2/email/deliverability-dashboard /v2/email/identities/{EmailIdentity}/configuration-set /v2/email/identities/{EmailIdentity}/dkim /v1/email/identities/EmailIdentity/dkim/signing /v2/email/identities/{EmailIdentity}/feedback /v2/email/identities/{EmailIdentity}/mail-from /v2/email/suppression/addresses /v2/email/outbound-bulk-emails /v2/email/configuration-sets/{ConfigurationSetName}/eventdestinations/{EventDestinationName} /v2/email/contact-lists/{ContactListName}/contacts/{EmailAddress} /v2/email/contact-lists/{ContactListName} /v2/email/custom-verification-email-templates/{TemplateName} /v2/email/identities/{EmailIdentity}/policies/{PolicyName} /v2/email/templates/{TemplateName} |
Headers | keyValue | no | - | Always | Used when you want to have a custom http header for the request. |
Query Params | keyValue | no | - | Always | Used when you want to have a custom query params for the http call. |
Body | json | no | - | Always | A payload of data can be sent to the server in the body of the request. |
Override Settings | boolean | no | false | Always | |
Follow Redirect | boolean | no | false | overrideSettings | Indicates that the resource has to be downloaded into a file instead of returning it in the response. |
Download | boolean | no | false | overrideSettings | If true the method won't return until the file has been downloaded, and it will return all the information of the file. |
File name | text | no | overrideSettings | If provided, the file will be stored with this name. If empty the file name will be calculated from the URL. | |
Full response | boolean | no | false | overrideSettings | Include extended information about response |
Connection Timeout | number | no | 5000 | overrideSettings | Connect timeout interval, in milliseconds (0 = infinity). |
Read Timeout | number | no | 60000 | overrideSettings | Read timeout interval, in milliseconds (0 = infinity). |
Name | Type | Description |
---|---|---|
response | object | Object resulting from the response to the endpoint call. |
For more information about how shortcuts or flow steps works, and how they are generated, take a look at the slingr-helpgen tool.
Click here to see the Customs Flow Steps
Description of Custom Flow Steps
Sends an email message.
Label | Type | Required | Default | Visibility | Description |
---|---|---|---|---|---|
To Addresses | yes | - | Always | An array that contains the email addresses of the "To" recipients for the email. | |
Bcc Addresses | no | - | Always | An array that contains the email addresses of the "BCC" (blind carbon copy) recipients for the email. | |
Cc Addresses | no | - | Always | An array that contains the email addresses of the "CC" (carbon copy) recipients for the email | |
From Email Address | no | - | Always | The email address to use as the "From" address for the email. The address that you specify has to be verified. | |
Message | text | yes | - | Always | The body of the message. |
Subject | text | yes | - | Always | The subject line of the email. The subject line can only contain 7-bit ASCII characters. However, you can specify non-ASCII characters in the subject line by using encoded-word syntax, as described in RFC 2047. |
Name | Type | Description |
---|---|---|
response | object | Object resulting from the response to the endpoint call. |
MANUALLY ADD THE DOCUMENTATION OF THESE HELPERS HERE...
SLINGR is a low-code rapid application development platform that accelerates development, with robust architecture for integrations and executing custom workflows and automation.
This endpoint is licensed under the Apache License 2.0. See the LICENSE
file for more details.