How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SAP Emarsys Email API

The Email API from SAP Emarsys — 34 operation(s) for email.

SAP Emarsys Email API is one of 30 APIs that SAP Emarsys publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Email. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 36 operations across 34 paths, and defines 3 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.emarsys.net/api, https://api.emarsys.net.

36 operations 34 paths 3 schemas 11 GET25 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.emarsys.net/api
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

SAP Emarsys Email API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-WSSE (X-WSSE). It accepts HTTP bearer tokens (JWT) (bearerAuth).

  • bearerAuth — To use this API, you must have an access token.

Paths & Operations 36

Across 34 paths, the API surfaces 36 operations — 11 GET, 25 POST. Each is listed below with its method, path, parameters, and response codes.

Email 36
POST
/v2/email/getcontacts
Export a Contact List
exportContactList body → 200400
POST
/v2/email/getresponses
Export Responses
exportResponses body → 200400
POST
/v2/email/{emailId}/preview
Preview Email Campaign Contents
previewEmailCampaignContents 1 param body → 200400
POST
/v2/email/{emailId}/sendtestmail
Send a Test Email
sendTestEmail 1 param body → 200400
POST
/v2/email/{emailId}/launch
Launch an Email Campaign
launchEmailCampaign 1 param body → 200400409
POST
/v2/email/{emailId}/broadcast
Launch an Email Campaign to Virtual Contacts (Broadcast)
launchEmailCampaignVirtualContacts 1 param body → 200400
POST
/v2/email/{emailId}/stop
Stop an Email Campaign
stopEmailCampaign 1 param → 200400
POST
/v2/email/getdeliverystatus
Query Delivery Status
queryDeliveryStatus body → 200400
POST
/v2/email/responses
Query Email Response Metrics and Deliverability
queryEmailResponseMetricsAndDeliverability body → 200400423
GET
/v2/email/{queryId}/responses
Get Email Response Metrics and Deliverability Results
getEmailResponseMetricsAndDeliverabilityResults 1 param → 200404
POST
/v2/email/getlaunchesofemail
List Email Campaign Launches
listEmailCampaignLaunches body → 200400
GET
/v2/email/{emailId}/personalization
List Personalization Alternate Texts
listPersonalizationAlternateTexts 1 param → 200400404
POST
/v2/email/{emailId}/url
Get the URL of a Launched Email Campaign Content
getUrlLaunchedEmailCampaignContent 1 param body → 200400
POST
/v2/email/unsubscribe
Unsubscribe a Contact from an Email Campaign
unsubscribeContactFromEmailCampaign body → 200400
POST
/v2/email
Create an Email Campaign
createEmailCampaign body → 200400
GET
/v2/email/
List Email Campaigns
listEmailCampaigns 14 params → 200400
GET
/v2/email/{emailId}/
Get Email Campaign Data
getEmailCampaignData 3 params → 200400
POST
/v2/email/{emailId}/updatesource
Update an Email Campaign Recipient Source
updateEmailCampaignRecipientSource 1 param body → 200400
POST
/v2/email/{emailId}/patch
Update an Email Campaign
updateEmailCampaign 1 param body → 200400403409
POST
/v2/email/delete
Delete an Email Campaign
deleteEmailCampaign body → 200400
POST
/v2/email/{emailId}/version
Version an Email Campaign
versionEmailCampaign 1 param body → 200400
POST
/v2/email/{emailId}/finalize
Finalize a Multi-language Email Campaign
finalizeMultilanguageEmailCampaign 1 param → 200500
POST
/v2/email/{emailId}/copy
Copy an Email Campaign
copyEmailCampaign 1 param body → 200400
GET
/v2/email/{campaign_id}/programs
List AC Programs That Use an Email Campaign
ListProgramsUsingEmailCampaign 1 param → 200404
GET
/api/email/reporting/v1/contacts/{contactId}/deliveryResults
Get delivery results
indexAction_1 3 params → 200400401500
GET
/v2/email/templates
List Email Templates
listEmailTemplates → 200
GET
/v2/email/templates/{templateId}
Get an Email Template
getEmailTemplate 1 param → 200404
POST
/v2/email/{emailId}/sections
Create a Section in a Template-based Email Campaign
createSectionInTemplateBasedEmailCampaign 1 param body → 200400
GET
/v2/email/{emailId}/sections
List Sections in a Template-based Email Campaign
listSectionsInTemplateBasedEmailCampaign 1 param → 200404
GET
/v2/email/{emailId}/sections/{sectionId}
Get a Section of a Template-based Email Campaign
getSectionOfTemplateBasedEmailCampaign 2 params → 200404
POST
/v2/email/{emailId}/sections/{sectionId}
Update a Section of a Template-based Email Campaign
updateSectionOfTemplateBasedEmailCampaign 2 params body → 200400
POST
/v2/email/{emailId}/sections/{sectionId}/delete
Delete a Section from a Template-based Email Campaign
deleteSectionFromTemplateBasedEmailCampaign 2 params → 200404
POST
/v2/email/{emailId}/trackedlinks
Create a Tracked Link in an Email Campaign
createTrackedLinkInEmailCampaign 1 param body → 200400
GET
/v2/email/{emailId}/trackedlinks/{relativeId}
List Tracked Links in an Email Campaign
listTrackedLinksInEmailCampaign 2 params → 200400
POST
/v2/email/{emailId}/trackedlinks/{linkId}
Update a Tracked Link in an Email Campaign
updateTrackedLinkInEmailCampaign 2 params body → 200400
POST
/v2/email/{emailId}/deletetrackedlinks/{linkId}deprecated
Delete a Tracked Link in an Email Campaign
deleteTrackedLinkInEmailCampaign 2 params → 200400

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are DeliveryResult (4 properties), default-response (3 properties), DeliveryResultsResponse (1 property). Each schema is shown below with its type and property counts.

default-response
object
See the following documents for details on the error codes: - [HTTP 200 errors](docs/response-codes/http-200-responses.md) - [HTTP 400 errors](docs/response-co…
3 properties
DeliveryResultsResponse
object
1 property
DeliveryResult
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

emarsys-email-api-openapi.yml Raw ↑

Other APIs SAP Emarsys publishes across the network.

SAP Emarsys Ac API
SAP Emarsys Administrator API
SAP Emarsys Blocklist API
SAP Emarsys Campaigns API
SAP Emarsys Client Configuration API
SAP Emarsys Client Configuration Test API
SAP Emarsys Condition API
SAP Emarsys Contact API
SAP Emarsys Contactlist API
SAP Emarsys Delivery Reports API
SAP Emarsys Emailcategory API
SAP Emarsys Event API
Where this information came from

This is an independent, third-party profile of SAP Emarsys Email API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.