Benötigen Sie Hilfe?
Im Maileon Help-Center finden Sie umfassende Dokumentationen zu unserem System.
Beliebte Suchanfragen: Importe | Rest-API | Integrationen | SMS
Partner API
General
| Name | Method / URL |
| Get Domains | GET https://api.maileon.com/partner/domains |
| Validate Domain | GET https://api.maileon.com/partner/domains/validate?key={key}&domain={domain} |
| Get Locales | GET https://api.maileon.com/partner/locales |
| Get Customer Accounts | GET https://api.maileon.com/partner/customer-accounts |
| Get Customer Accounts Count | GET https://api.maileon.com/partner/customer-accounts/count |
| Get Newsletter Accounts | GET https://api.maileon.com/partner/newsletter-accounts |
| Get Newsletter Accounts Count | GET https://api.maileon.com/partner/newsletter-accounts/count |
Reports
| Name | Method / URL |
| Distributor Report: Checks | GET https://api.maileon.com/partner/distributor/reports/checks |
| Distributor Report: CSA | GET https://api.maileon.com/partner/distributor/reports/csa |
Account Jobs
| Name | Method / URL |
| Get a List of Jobs running for a given Partner | GET https://api.maileon.com/partner/account-jobs |
| Get Information about a given Job | GET https://api.maileon.com/partner/account-jobs/{jobId} |
| Add an Account-Creation Job | POST https://api.maileon.com/partner/account-jobs |
Newsletter Account Setup
| Name | Method / URL |
| Create API-Key for Newsletter Account | POST https://api.maileon.com/partner/newsletter-accounts/{newsletterAccountId}/apikey |
| Get Account Details | GET https://api.maileon.com/partner/newsletter-accounts/{newsletterAccountId} |
| Set Account Status | POST https://api.maileon.com/partner/newsletter-accounts/{newsletterAccountId}/status |
| Get a List of Mailing Domains | GET https://ap.maileon.com/partner/newsletter-accounts/{accountId}/mailing-domains/ |
| Get Details About a single Mailing Domain | GET https://api.maileon.com/partner/newsletter-accounts/{accountId}/mailing-domains/{mailingDomain} |
| Add a Mailing Domain to a Newsletter Account | POST https://api.maileon.com/partner/newsletter-accounts/{accountId}/mailing-domains/{mailingDomain} |
| Get Status of a Mailing Domain | GET https://api.maileon.com/partner/newsletter-accounts/{accountId}/mailing-domains/{mailingDomain}/status |
| Set Status of a Mailing Domain | PUT https://api.maileon.com/partner/newsletter-accounts/{accountId}/mailing-domains/{mailingDomain}/status |
| Get a List of Products for Newsletter Account | GET https://api.maleon.com/partner/settings/products?nl_account_id={newsletterAccountId} |
| Activate or Deactivate a Product | PUT https://api.maileon.com/partner/settings/products/{product}?nl_account_id={newsletterAccountId} |
| Get the History of Product Activation Changes | GET https://api.maileon.com/partner/settings/products/{product}/logs?nl_account_id={newsletterAccountId} |
| Upload Maileon Emailing/Article Templates | POST https://api.maileon.com/partner/media/templates?key={key}&nl_account_id={newsletterAccountId} |
Newsletter Account Setup: Managing Prepaid Contingents
Contingents represent a prepaid volume that is used when sending mails. Please note that times are represented as iso8601datetime.
| Name | Method / URL |
| Request Prepaid Setting Status | GET https://api.maileon.com/partner/settings/prepaids/status?key={k}&nl_account_id={nlaId} |
| Set Prepaid Setting Status | POST https://api.maileon.com/partner/settings/prepaids/status?key={k}&nl_account_id={nlaId} |
| Get List of Contingents | GET https://api.maileon.com/partner/settings/prepaids/contingents?key={k}&nl_account_id={nlaId} |
| Create New Contingent | PUT https://api.maileon.com/partner/settings/prepaids/contingents?key={k}&nl_account_id={nlaId} |
| Get Specific Contingent | GET https://api.maileon.com/partner/settings/prepaids/contingents/contingent/{cid}?key={k}&nl_account_id={nlaId} |
| Update Specific Contingent | POST https://api.maileon.com/partner/settings/prepaids/contingents/contingent/{cid}?key={k}&nl_account_id={nlaId} |
| Delete Specific Contingent | DELETE https://api.maileon.com/partner/settings/prepaids/contingents/contingent/{cid}?key={k}&nl_account_id={nlaId} |
User and Roles
| Name | Method / URL |
| Create a Custom Role | POST https://api.maileon.com/partner/settings/roles?key={key}&nl_account_id={newsletterAccountId} |
| Delete a Custom Role | DELETE https://api.maileon.com/partner/settings/roles/{roleName}?key={key}&nl_account_id={newsletterAccountId} |
| Get all User Accounts | GET https://api.maileon.com/partner/settings/users?key={key}&nl_account_id={newsletterAccountId} |
| Create a User Account | POST https://api.maileon.com/partner/settings/users?key={key}&nl_account_id={newsletterAccountId} |
| Delete a User Account | DELETE https://api.maileon.com/partner/settings/users/{email}?key={key}&nl_account_id={newsletterAccountId} |
| Assign a Role to a User | PUT https://api.maileon.com/partner/settings/users/{email}/roles?key={key}&nl_account_id={newsletterAccountId}&roleName={roleName} |
| Delete a Role from an User | DELETE https://api.maileon.com/partner/settings/users/{email}/roles?key={key}&nl_account_id={newsletterAccountId}&roleName={roleName} |
Webhooks
| Name | Method / URL |
| Datastructure | |
| Get a List of Webhooks | GET https://api.maileon.com/partner/settings/webhooks?key={key}&nl_account_id={newsletterAccountId} |
| Create a Webhook | POST https://api.maileon.com/partner/settings/webhooks?key={key}&nl_account_id={newsletterAccountId} |
| Get a Webhook | GET https://api.maileon.com/partner/settings/webhooks/{id}?key={key}&nl_account_id={newsletterAccountId} |
| Delete a Webhook | DELETE https://api.maileon.com/partner/settings/webhooks/{id}?key={key}&nl_account_id={newsletterAccountId} |
Partner Blacklists
| Name | Method / URL |
| Partner Blacklists | GET https://api.maileon.com/partner/blacklists?key={key}&page_size={pageSize}&page_index={pageIndex} |
| Create Partner Blacklist | POST https://api.maileon.com/partner/blacklists/{id}?key={key}&name={name}&status={status}&type={type} |
| Get Partner Blacklist | GET https://api.maileon.com/partner/blacklists/{id}?key={key} |
| Update Partner Blacklist | PUT https://api.maileon.com/partner/blacklists/{id}?key={key}&name={newName}&status={newStatus}&type={newType} |
| Delete Partner Blacklists | DELETE https://api.maileon.com/partner/blacklists/{id}?key={key} |
| Get Accounts of a Partner Blacklist | GET https://api.maileon.com/partner/blacklists/{id}/accounts?key={key} |
| Add Accounts to a Partner Blacklist | POST https://api.maileon.com/partner/blacklists/{id}/accounts?key={key}&newsletterAccountIds={ newsletterAccountIds0}&newsletterAccountIds={newsletterAccountIds1} |
| Get Patterns of a Partner Blacklist | GET https://api.maileon.com/partner/blacklists/{id}/patterns?key={key}&page_size={pageSize}&page_index={pageIndex} |
| Upload Patterns to Partner Blacklist | POST https://api.maileon.com/partner/blacklists/{id}/patterns?key={key} |
Distributor Volume Report
| Name | Method / URL |
| Distributor Volume Report | GET https://api.maileon.com/partner/report/accounts_volume&key={key}&from={from}&to={to}&page_size={pageSize}&page_index={pageIndex}&customer_account_id={customerAccountId}&newsletter_account_id={newsletterAccountId}&account_type={accountType} |
Distributor SMS Report
| Name | Method / URL |
| Distributor SMS Report | GET https://api.maileon.com/partner/report/sms&key={key}&from={from}&to={to}&page_size={pageSize}&page_index={pageIndex}&newsletter_account_id={newsletterAccountId}&process_id={processId} |
Appendix
| Name | Method / URL |
| Appendix: List of Products |