+49 69 83008980 service@xqueue.com
Benötigen Sie Hilfe?

Rest API v1.0

Sie sind hier:
< Alle Themen

 

Common

Basics

The base-URL is https://api.maileon.com/1.0/

Make sure to use HTTPS. If you have trouble with the certificate fix the problems. In some older examples HTTP might have been used but this is not allowed any longer, you will get an error status code 403.

General
Security Mechanisms
Access Logs of the API
Using MergeTags in Mailings
Frequently Asked Questions

Using the API
Authentication
Mediatypes
Data Compression
Pagination
HTTP Status Codes
Guidelines for XML Documents

Starting with Development
Check our Guidelines

 

Ping

Goal of this resource is to provide a convenient API test functionality. It should allow the developer to easily verify the correct setup including the proper permissions for the respective API key.
Resources

NameMethod / URL
GET TestGET https://api.maileon.com/1.0/ping
POST TestPOST https://api.maileon.com/1.0/ping
PUT TestPUT https://api.maileon.com/1.0/ping
DELETE TestDELETE https://api.maileon.com/1.0/ping

 

Contacts

Resources

General

 

NameMethod / URL
Delete All ContactsDELETE https://api.maileon.com/1.0/contacts
Get Count ContactsGET GET https://api.maileon.com/1.0/contacts/count
Get ContactsGET https://api.maileon.com/1.0/contacts
Get Contacts By Filter IdGET https://api.maileon.com/1.0/contacts/filter/{contactFilterId}
Count Contacts By Filter IdGET https://api.maileon.com/1.0/contacts/filter/{contactFilterId}/count
Count Active Contacts By Filter IdGET https://api.maileon.com/1.0/contacts/filter/{contactFilterId}/count/active
Get Blocked ContactsGET https://api.maileon.com/1.0/contacts/contact/blocked
Synchronize ContactsPOST https://api.maileon.com/1.0/contacts
Create Custom FieldPOST https://api.maileon.com/1.0/contacts/fields/custom/:field
Get Custom FieldsGET https://api.maileon.com/1.0/contacts/fields/custom
Delete Custom FieldDELETE https://api.maileon.com/1.0/contacts/fields/custom/:field
Delete Standard Field ValuesDELETE https://api.maileon.com/1.0/contacts/fields/standard/:field/values
Delete Custom Field ValuesDELETE https://api.maileon.com/1.0/contacts/fields/custom/:field/values
Rename Custom FieldPUT https://api.maileon.com/1.0/contacts/fields/custom/:oldname/:newname

 

By Maileon ID

 

NameMethod / URL
Delete Contact By Maileon IDDELETE https://api.maileon.com/1.0/contacts/contact
Get Contact By Maileon IDGET https://api.maileon.com/1.0/contacts/contact
Unsubscribe Contact By Maileon IDDELETE https://api.maileon.com/1.0/contacts/contact/unsubscribe
Update Contact By Maileon IDPUT https://api.maileon.com/1.0/contacts/contact
Add Unsubscription Reason to Already Unsubscribed ContactPUT https://api.maileon.com/1.0/contacts/contact/unsubscribe/reasons

 

By Email-Address

 

NameMethod / URL
Create ContactPOST https://api.maileon.com/1.0/contacts/email/:email
Create Contact (JSON)POST https://api.maileon.com/1.0/contacts/email/:email
Update Contact By EmailPUT https://api.maileon.com/1.0/contacts/email/:email
Delete Contacts By EmailDELETE https://api.maileon.com/1.0/contacts/email/:email
Get Contact By EmailGET https://api.maileon.com/1.0/contacts/email/:email
Get Contacts By EmailGET https://api.maileon.com/1.0/contacts/emails/:email
Unsubscribe Contacts By EmailDELETE https://api.maileon.com/1.0/contacts/email/:email/unsubscribe

 

By External-ID

 

NameMethod / URL
Create Contact By External IdPOST https://api.maileon.com/1.0/contacts/externalid/:value
Create Contact By External Id (JSON)POST https://api.maileon.com/1.0/contacts/externalid/:value
Update Contact By External IdPUT https://api.maileon.com/1.0/contacts/externalid/:value
Delete Contacts By External IdDELETE https://api.maileon.com/1.0/contacts/externalid/:value
Get Contacts By External IdGET https://api.maileon.com/1.0/contacts/externalid/:value
Unsubscribe Contacts By External IDDELETE https://api.maileon.com/1.0/contacts/externalId/:value/unsubscribe

Appendices
Contacts
Standard Contact Fields
Custom Contact Fields
Synchronize Contacts Error Codes

Contactfilters

Resources

NameMethod / URL
Get Count ContactfiltersGET https://api.maileon.com/1.0/contactfilters/count
Get ContactfilterGET https://api.maileon.com/1.0/contactfilters/contactfilter/{contactFilterId}
Get ContactfiltersGET https://api.maileon.com/1.0/contactfilters
Refresh Contactfilter-ContactsGET https://api.maileon.com/1.0/contactfilters/contactfilter/{contactFilterId}/refresh
Update ContactfilterPUT https://api.maileon.com/1.0/contactfilters/contactfilter/{contactFilterId}
Delete ContactfilterDELETE https://api.maileon.com/1.0/contactfilters/contactfilter/{contactFilterId}
Get Contacts By Filter Id (See Contacts Resource)GET https://api.maileon.com/1.0/contacts/filter/{contactFilterId}
Get Contactfilter lock stateGET https://api.maileon.com/1.0/contactfilters/contactfilter/{contactFilterId}/lock
Set Contactfilter lock statePOST https://api.maileon.com/1.0/contactfilters/contactfilter/{contactFilterId}/lock

Appendices
Contactfilter XML structure

Targetgroups

Resources

NameMethod / URL
Get Targetgroup countGET https://api.maileon.com/1.0/targetgroups/count
Get TargetgroupsGET https://api.maileon.com/1.0/targetgroups
Create TargetgroupPOST https://api.maileon.com/1.0/targetgroups
Get TargetgroupGET https://api.maileon.com/1.0/targetgroups/targetgroup/{groupId}
Delete TargetgroupDELETE https://api.maileon.com/1.0/targetgroups/targetgroup/{groupId}

Appendices
Targetgroup XML structure

Reports

Resources

NameMethod / URL
Get OpensGET https://api.maileon.com/1.0/reports/opens
Get Unique OpensGET https://api.maileon.com/1.0/reports/opens/unique
Get ClicksGET https://api.maileon.com/1.0/reports/clicks
Get Unique ClicksGET https://api.maileon.com/1.0/reports/clicks/unique
Get BouncesGET https://api.maileon.com/1.0/reports/bounces
Get Unique BouncesGET https://api.maileon.com/1.0/reports/bounces/unique
Get BlocksGET https://api.maileon.com/1.0/reports/get-blocks
Get UnsubscriptionsGET https://api.maileon.com/1.0/reports/unsubscriptions
Get Unsubscription ReasonsGET https://api.maileon.com/1.0/reports/unsubscriptions/reasons
Get SubscribersGET https://api.maileon.com/1.0/reports/subscribers
Get RecipientsGET https://api.maileon.com/1.0/reports/recipients
Get ConversionsGET https://api.maileon.com/1.0/reports/analytics/conversions
Get Unique ConversionsGET https://api.maileon.com/1.0/reports/analytics/conversions/unique
Get RevenueGET https://api.maileon.com/1.0/reports/analytics/conversions/revenue

Appendices
Social Networks List
Bouncecodes

Mailings

Resources

NameMethod / URL
Create MailingPOST https://api.maileon.com/1.0/mailings
Copy MailingPOST https://api.maileon.com/1.0/mailings/:mailingid/copy
Delete MailingDELETE https://api.maileon.com/1.0/mailings/:mailingId
Get Template MailingPUT https://api.maileon.com/1.0/mailings/:mailingId/template
Set Template MailingPUT https://api.maileon.com/1.0/mailings/:mailingId/template
Reset Contents to TemplatePUT https://api.maileon.com/1.0/mailings/:mailingId/contents/reset
Get Mailings By Schedule TimeGET https://api.maileon.com/1.0/mailings/filter/scheduletime
Get Mailings By StatesGET https://api.maileon.com/1.0/mailings/filter/states
Get Mailings By TypesGET https://api.maileon.com/1.0/mailings/filter/types
Get Mailings By SubjectGET https://api.maileon.com/1.0/mailings/filter/subject
Get Mailings By Creator_NameGET https://api.maileon.com/1.0/mailings/filter/creatorname
Get Mailings By KeywordsGET https://api.maileon.com/1.0/mailings/filter/keywords
Get Mailing ID By NameGET https://api.maileon.com/1.0/mailings/name/:mailingName
Get NameGET https://api.maileon.com/1.0/mailings/:mailingid/name
Set NamePOST https://api.maileon.com/1.0/mailings/:mailingid/name
Get TypeGET https://api.maileon.com/1.0/mailings/:mailingid/type
Get StateGET https://api.maileon.com/1.0/mailings/:mailingid/state
Is SealedGET https://api.maileon.com/1.0/mailings/:mailingid/sealed
Disable QoS ChecksPUT https://api.maileon.com/1.0/mailings/:mailingid/settings/disableQosChecks
Get Tracking StrategyGET https://api.mailing.com/1.0/mailings/:mailingid/settings/trackingstrategy
Set Tracking StrategyPOST https://api.mailing.com/1.0/mailings/:mailingid/settings/trackingstrategy
Get Max Content SizeGET https://api.maileon.com/1.0/mailings/:mailingid/settings/maxcontentsize
Get Speed LevelGET https://api.maileon.com/1.0/mailings/:mailingid/settings/speedlevel
Set Speed LevelPOST https://api.maileon.com/1.0/mailings/:mailingid/settings/speedlevel
Get TagsGET https://api.mailing.com/1.0/mailings/:mailingid/settings/tags
Set TagsPOST https://api.mailing.com/1.0/mailings/:mailingid/settings/tags
Get LocaleGET https://api.mailing.com/1.0/mailings/:mailingid/settings/locale
Set LocaleGET https://api.maileon.com/1.0/reports/analytics/conversions
Get SubjectGET https://api.maileon.com/1.0/mailings/:mailingid/contents/subject
Set SubjectPOST https://api.maileon.com/1.0/mailings/:mailingid/contents/subject
Get Preview TextGET https://api.maileon.com/1.0/mailings/:mailingid/contents/previewtext
Set Preview TextPOST https://api.maileon.com/1.0/mailings/:mailingid/contents/previewtext
Get Sender AddressGET https://api.maileon.com/1.0/mailings/:mailingid/contents/sender
Set Sender AddressPOST https://api.maileon.com/1.0/mailings/:mailingid/contents/sender
Get Sender AliasGET https://api.maileon.com/1.0/mailings/:mailingid/contents/senderalias
Set Sender AliasPOST https://api.maileon.com/1.0/mailings/:mailingid/contents/senderalias
Get Reply-To-AddressGET https://api.maileon.com/1.0/mailings/:mailingid/settings/replyto
Set Reply-To-AddressPOST https://api.maileon.com/1.0/mailings/:mailingid/settings/replyto
Get Recipient AliasGET https://api.maileon.com/1.0/mailings/:mailingid/contents/recipientalias
Set Recipient AliasPOST https://api.maileon.com/1.0/mailings/:mailingid/contents/recipientalias
Get HtmlGET https://api.maileon.com/1.0/mailings/:mailingid/contents/html
Set HtmlPOST https://api.maileon.com/1.0/mailings/:mailingid/contents/html
Get TextGET https://api.maileon.com/1.0/mailings/:mailingid/contents/text
Set TextPOST https://api.maileon.com/1.0/mailings/:mailingid/contents/text
Fill RSS SmartContent TagsPOST https://api.maileon.com/1.0/mailings/:mailingid/contents/smartmailing/rss
Send NowPOST https://api.maileon.com/1.0/mailings/:mailingid/sendnow
Add AttachmentPOST https://api.maileon.com/1.0/mailings/:mailingid/attachments
Get AttachmentGET https://api.maileon.com/1.0/mailings/:mailingid/attachments/:attachmentid
Get AttachmentsGET https://api.maileon.com/1.0/mailings/:mailingid/attachments
Get Count AttachmentsGET https://api.maileon.com/1.0/mailings/:mailingid/attachments/count
Delete AttachmentDELETE https://api.maileon.com/1.0/mailings/:mailingid/attachments
Delete AttachmentsGET https://api.maileon.com/1.0/mailings/:mailingid/contents/previewtext
Copy AttachmentsPUT https://api.maileon.com/1.0/mailings/:targetmailingid/attachments
Get Max Attachment SizeGET https://api.maileon.com/1.0/mailings/:mailingid/settings/maxattachmentsize
Get Mailing Archive URLGET https://api.maileon.com/1.0/mailings/:mailingid/archiveurl
Get Mailing Report URLGET https://api.maileon.com/1.0/mailings/:mailingid/reporturl
Sent Testmail to Single ContactPOST https://api.maileon.com/1.0/mailings/:mailingid/sendtestemail
Send Testmail to Test TargetgroupPOST https://api.maileon.com/1.0/mailings/:mailingid/checks/testsendout
Get Test Sendout resultGET https://api.maileon.com/1.0/mailings/:mailingid/checks/testsendout
Start Attention checkPOST https://api.maileon.com/1.0/mailings/:mailingid/checks/attention
Get Attention check resultGET https://api.maileon.com/1.0/mailings/:mailingid/checks/attention
Start Display checkPOST https://api.maileon.com/1.0/mailings/:mailingid/checks/display
Get Display check resultGET https://api.maileon.com/1.0/mailings/:mailingid/checks/display
Start Image checkPOST https://api.maileon.com/1.0/mailings/:mailingid/checks/image
Get Image check resultGET https://api.maileon.com/1.0/mailings/:mailingid/checks/image
Start Link checkPOST https://api.maileon.com/1.0/mailings/:mailingid/checks/link
Get Link check resultGET https://api.maileon.com/1.0/mailings/:mailingid/checks/link
Start Message Size checkPOST https://api.maileon.com/1.0/mailings/:mailingid/checks/messagesize
Get Message size check resultGET https://api.maileon.com/1.0/mailings/:mailingid/checks/messagesize
Start Spam checkPOST https://api.maileon.com/1.0/mailings/:mailingid/checks/spam
Get Spam check resultGET https://api.maileon.com/1.0/mailings/:mailingid/checks/spam
Add custom mailing propertiesPOST https://api.maileon.com/1.0/mailings/:mailingid/settings/properties
Update custom mailing propertiesPUT https://api.maileon.com/1.0/mailings/:mailingid/settings/properties
Get custom mailing propertiesGET https://api.maileon.com/1.0/mailings/:mailingid/settings/properties
Delete custom mailing propertiesDELETE https://api.maileon.com/1.0/mailings/:mailingid/settings/properties
Get mailing blacklistsGET https://api.maileon.com/1.0/mailings/:mailingid/mailingblacklists
Add mailing blacklistPOST https://api.maileon.com/1.0/mailings/:mailingid/mailingblacklists/:blacklistid
Remove mailing blacklistDELETE https://api.maileon.com/1.0/mailings/:mailingid/mailingblacklists/:blacklistid
Get mailing domainGET https://api.maileon.com/1.0/mailings/:mailingid/domain

Resources only applicable for regular mailings

NameMethod / URL
Get Target Group IdGET https://api.maileon.com/1.0/mailings/:mailingid/targetgroupid
Set Target Group IdPOST https://api.maileon.com/1.0/mailings/:mailingid/targetgroupid
Create SchedulePUT https://api.maileon.com/1.0/mailings/:mailingid/schedule
Get ScheduleGET https://api.maileon.com/1.0/mailings/:mailingid/schedule
Update SchedulePOST https://api.maileon.com/1.0/mailings/:mailingid/schedule
Delete ScheduleDELETE https://api.maileon.com/1.0/mailings/:mailingid/schedule
Set Contact LimitPOST https://api.maileon.com/1.0/mailings/:mailingid/settings/contacts_limit
Get Contacts LimitGET https://api.maileon.com/1.0/mailings/:mailingid/settings/contacts_limit
Set target group update settingPOST https://api.maileon.com/1.0/mailings/:mailingid/settings/targetgroup_update
Check target group update settingGET https://api.maileon.com/1.0/mailings/:mailingid/settings/targetgroup_update
Start Personalization checkPOST https://api.maileon.com/1.0/mailings/:mailingid/checks/personalization
Get Personalization check resultGET https://api.maileon.com/1.0/mailings/:mailingid/checks/personalization
Start Approval sendoutPOST https://api.maileon.com/1.0/mailings/:mailingid/checks/approvalprocess
Get Approval Sendout resultGET https://api.maileon.com/1.0/mailings/:mailingid/checks/approvalprocess
Start Bounce checkPOST https://api.maileon.com/1.0/mailings/:mailingid/checks/bounce
Get Bounce check resultGET https://api.maileon.com/1.0/mailings/:mailingid/checks/bounce
Get “Post-Sendout Cleanup” StateGET https://api.maileon.com/1.0/mailings/:mailingid/settings/post_sendout_cleanup
Set “Post-Sendout Cleanup” StatePOST https://api.maileon.com/1.0/mailings/:mailingid/settings/post_sendout_cleanup

Resources only applicable for trigger mailings

NameMethod / URL
Create DispatchingPUT https://api.maileon.com/1.0/mailings/:mailingid/dispatching
Get DispatchingGET https://api.maileon.com/1.0/mailings/:mailingid/dispatching
Delete TriggerDELETE https://api.maileon.com/1.0/mailings/:mailingid/dispatching
Get “Ignore Permission” StateGET https://api.maileon.com/1.0/mailings/:mailingid/settings/ignorepermission
Set “Ignore Permission” StatePOST https://api.maileon.com/1.0/mailings/:mailingid/settings/ignorepermission

Resources only applicable for doi mailings

NameMethod / URL
Get DOI KeyGET https://api.maileon.com/1.0/mailings/:mailingid/settings/doi_key
Set DOI KeyPOSThttps://api.maileon.com/1.0/mailings/:mailingid/settings/doi_key

Appendices
Merge Tags

Transactions (Called Contact-Events in Maileon-UI)

Transactions API Overview
Resources

NameMethod / URL
Get Transaction Types CountGET https://api.maileon.com/1.0/transactions/types
Get All Transaction TypesGET https://api.maileon.com/1.0/targetgroups
Get Transaction TypeGET https://api.maileon.com/1.0/transactions/types/:transactionTypeId
Create Transaction TypePOST https://api.maileon.com/1.0/transactions/types
UpdateTransaction TypePUT https://api.maileon.com/1.0/transactions/types
Delete Transaction TypeDELETE https://api.maileon.com/1.0/transactions/types/:transactionTypeId
Create TransactionsPOST https://api.maileon.com/1.0/transactions
Delete Transactions Before a Given DateDELETE https://api.maileon.com/1.0/transactions

 

Marketing-Automation

Resources

NameMethod / URL
Start MA ProgramPOST https://api.maileon.com/1.0/marketing-automation/:programId

 

Media

Resources

NameMethod / URL
Get List of Mailing TemplatesGET https://api.maileon.com/1.0/media/templates/mailings

 

Blacklists

Blacklists Overview
Resources

NameMethod / URL
Get BlacklistsGET https://api.maileon.com/1.0/blacklists
Get BlacklistGET https://api.maileon.com/1.0/blacklists/:blacklistId
Add Entries to BlacklistPOST https://api.maileon.com/1.0/blacklists/:blacklistId/actions

 

Mailing Blacklists

Resources

NameMethod / URL
Get Mailing BlacklistsGET https://api.maileon.com/1.0/mailingblacklists
Get Mailing BlacklistGET https://api.maileon.com/1.0/mailingblacklists/:id
Create Mailing BlacklistPOST https://api.maileon.com/1.0/mailingblacklists
Update Mailing BlacklistPUT https://api.maileon.com/1.0/mailingblacklists/:id
Delete Mailing BlacklistDELETE https://api.maileon.com/1.0/mailingblacklists/:id
Add expressions to mailing blacklistPOST https://api.maileon.com/1.0/mailingblacklists/:id/expressions

 

Account

Resources

NameMethod / URL
Get Account PlaceholdersGET https://api.maileon.com/1.0/account/placeholders
Set Account PlaceholdersPOST https://api.maileon.com/1.0/account/placeholders
Update Account PlaceholdersPUT https://api.maileon.com/1.0/account/placeholders
Delete Account PlaceholdersDELETE https://api.maileon.com/1.0/account/placeholders
Inhaltsverzeichnis

Bleiben Sie Up-to-Date und profitieren Sie von spannenden News und Aktionen.

Maileon ist ein Produkt der XQueue GmbH

Newsletter Pop-Up