Versions Compared

Key

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

...

Warning
titleRestricted feature

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

Solution

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). 

...

Optional

Name

Type

Meaning

false

NameAndSurname

String

The 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

  • EN (English)
  • IT (Italian)
  • ES (Spanish)
  • FR (French)
  • PT (Portuguese)
  • JA (Japanese)
  • DA (Danish)
false

IpAddress

StringThe 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
trueRefererStringThe hostname of the machine that performs the request
trueUserAgentStringInformation about the browser that is used to perform the request

...