Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
{
	"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"
}
    1. Passed in arguments, can be sent as Xml or Json according to the user defined value set in the header (http://help.mailup.com/display/mailupapi/Resource+access+data+format)
    2. Arguments
  1. are all mandatory
    1. and their meaning can be explained as follows :

 

Optional

Name

Type

Meaning

false

NameAndSurname

String

...

Applicant first and family names

false

Company

String

Business Name

false

Email

...

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 : EN, ES or IT ( English, Spanish or Italian)

...

false

IpAddress

StringIP address of the client that performs the request

false

IsUSA

Boolean

Cost centre, put False for activations from the Euro zone, else put True

false

RegisterToNewsletter

Boolean

True if the applicant is intended to receive Mailup Newsletters
trueRefererStringHostname of the machine that performs the request
trueUserAgentStringInformation about the browser that is used to perform the request

 

  •  
    • (Please see Resource Access Requirements)
      [Authorization] = "Basic " + Base64(ClientId + ":" + ClientSecret)
    • Callback response returns an Identity (ID) that can be used to track activation status with a further callback to the following https://services.mailup.com/API/v1.1/Rest/PublicService.svc/Console/TrialActivationStatus. (TrialActivationStatus)
    • Returned codes from TrialActivationStatus are:

      Code Block
      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 thi 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 thi issue) 
      7 – Re elaborated (The trial activation is in progress, soon you’ll receive the account credentials)
    • Any activation request can be performed with a single
  • callback
    • call to TrialActivation  and further callbacks looping on TrialActivationStatus until it returns ID=2

Note

No more than one trial activation is allowed from the same caller IP. In order to facilitate 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 actually create a new account, it just returns an activation request code.

 

Relevant notes

    • Automated consoles’ activations require a couple of minutes at least to complete. When completed, the activation process will take care of sending activation confirmation message and login credentials to the applicant’s defined email address
    • Login credentials can be only transmitted by email as there’s no API method in charge to.
    • Currently there’s no implemented functionality in the MailUp API set to
  • retieve
    • retrieve the list of activated consoles from a certain application. This ability is planned to be implemented in the near future.