Applications that integrate with MailUp may wish to request new MailUp accounts if the user of the application is not yet a MailUp user.
Account activation via API is an advanced feature that is disabled by default. It requires manual activation by the MailUp team. Please contact MailUp to have this feature enabled for your application. You will be asked to provide your Client ID |
You can build the ability to activate a new MailUp account right into your application by using the MailUp public API endpoint. Below you can find the expected workflow and the technical details for implementing it. An example of an application using the MailUp account provisioning API is the APS package. Below we describe how to activate a free trial account, but the same methods can be used - upon request - to provide custom setups (ie Whitelabel platform with custom features enabled).
Access to the resources (lists, messages, subscribers) of the newly activated account requires an authentication and authorization process that is different than the one used for the trial account activation methods: specifically, it requires OAuth2 authentication with a token that has to be periodically refreshed when HTTP 401 error is returned. Please refer to "Samples and Wrappers" if you need a working example of an application that properly uses the refresh token to access to MailUp resources. See more information about /wiki/spaces/mailupapi/pages/36340656.
{ "Company":"String content", "Email":"String content", "IpAddress":"String content", "IsUSA":true, "Language":"String content", "NameAndSurname":"String content", "PhoneNumber":"String content", "Referer":"String content", "RegisterToNewsletter":true, "UserAgent":"String content" } |
Optional | Name | Type | Meaning |
---|---|---|---|
false | NameAndSurname | String | The applicant first and family names |
false | Company | String | Business Name |
false | String | Email address who will be sent of the confirmation request and access information | |
false | PhoneNumber | String | Applicant phone number |
false | Language | String | console language, please use one of the following:
|
false | IpAddress | String | The IP address of the client that performs the request |
false | IsUSA | Boolean | Cost center put False for activations from the Eurozone, else put True |
false | RegisterToNewsletter | Boolean | True if the applicant is intended to receive Mailup Newsletters |
true | Referer | String | The hostname of the machine that performs the request |
true | UserAgent | String | Information about the browser that is used to perform the request |
Returned codes from TrialActivationStatus are:
1 – Confirmed (Request has been accepted, activation is ready to start) 2 – Processed (Your trial has been activated and you’ll receive the account credentials in your inbox) 3 – Error (An error occurred and an alert has been notified to our support team in order to solve this issue) 4 – Manual (MailUp platform is in maintenance mode, your request will be processed as soon as the platform will be restored) 5 – In progress (The trial activation is in progress, soon you’ll receive the account credentials) 6 – Blocked (An error occurred and an alert has been notified to our support team in order to solve this issue) 7 – Re elaborated (The trial activation is in progress, soon you’ll receive the account credentials) |
No more than one trial activation is allowed from the same caller IP. To support the development and to avoid the creation of unused accounts, developers can take advantage of the "fake activation" feature, which can be used when IpAddress = 127.0.0.1 or when IpAddress starts with "192.168.". "Fake activation" does not create a new account and it returns "-1" as activation request code. In addition, in the case of "fake activation", a random value1 is returned when calling TrialActivationStatus (1) returned values have a range that spans from 1 to 7 and they can be used to simulate real cases. Due to an API limitation, also "0 - Not Confirmed" may be returned in case of fake activation, please manage this case exactly as "1 - Confirmed" |