Page Comparison

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Management

Use these methods to retrieve informations about your environment (profiles, packages and languages) and configure your environment.

Note that all management resource requests ignore ExternalUserId value, so your client can perform these requests having or not this value.

...

Description

...

Get retailer-defined profiles

...

HTTP Method

...

GET

...

URL

...

https://services.mailup.com/API/v1.1/Rest/RetailerService.svc/Management/Profile

...

JSON request (example)

...

none

...

JSON response (example)

...

On this page:

Management

Use these methods to retrieve pieces of information about your environment (profiles, packages, and languages) and configure your environment.

Note that all management resource requests ignore ExternalUserId value, so your client can perform these requests having or not this value.

Anchor
GetProfiles GetProfiles

Get retailer-defined profiles

https://services.mailup.com/API/v1.1/Rest/RetailerService.svc/Management/Profile

HTTP/1.1 200 OK
 
{
	"IsPaginated":false,
	"Items":[
		{
			"ClientCode":1,
			"Description":"Trial",
			"Id":1046,
			"Name":"Trial"
		},
		{
			"ClientCode":2,
			"Description":"Economy",
			"Id":1047,
			"Name":"Economy"
		},
		{
			"ClientCode":3,
			"Description":"Premium",
			"Id":1048,
			"Name":"Premium"
		}],
	"PageNumber":0,
	"PageSize":20,
	"Skipped":0,
	"TotalElementsCount":3
}

Anchor
GetPacks GetPacks

Get retailer-defined packages by profile

To retrieve available languages you need to provide this parameter:

https://services.mailup.com/API/v1.1/Rest/RetailerService.svc/Management/Profile/{id_Profile}/Pack

HTTP/1.1 200 OK
 
{
	"IsPaginated":false,
	"Items":[
		{
			"ClientCode":1,
			"Description":"Pacchetto che consente di aumentare la velocità di invio di 300 mail\/ora",
			"Id":534,
			"Max":5,
			"Min":1,
			"Name":"VelocitaAggiuntiva300"
		},
		{
			"ClientCode":2,
			"Description":"Pacchetto che consente di aggiungere 300 crediti alla console",
			"Id":535,
			"Max":65535,
			"Min":1,
			"

Name":"

Crediti300"

}],
	"PageNumber":0,
	"PageSize":20,
	"Skipped":0,
	"TotalElementsCount":2
}

https://services.mailup.com/API/v1.1/Rest/RetailerService.svc/Management/Profile?PageSize=2&PageNumber=1

Get retailer-defined packages by profile

To retrieve available languages you need to provide this parameter:

Errors

Note

1. Min e Max equals the minimum and a maximum number of packages manageable by selected profile.

Anchor
GetLanguages GetLanguages

Get the available languages by profile

To retrieve available packages you need to provide this parameter:

https://services.mailup.com/API/v1.1/Rest/RetailerService.svc/Management/Profile/{id_Profile}/

Lang

HTTP/1.1 200 OK
 

Errors

Note

1. Min e Max equals to the minimum and maximum number of packages manageable by selected profile.

...

To retrieve available packages you need to provide this parameter:

 [
    "JA",
    "ID",
    "IT",
    "ES",
    "FR",
    "PT",
    "ZH",
    "EN"
  ]

Errors

Account

 Use these methods to manage retailers' customer's accounts. With these methods, you can create new accounts, add or remove packages and get what you need to log in to accounts.

Note that all account resource requests need an ExternalUserId value, so you have to authenticate specifying the retailer's customer unique identifier. APIs validates client requests forbidden the access if:

• AccessToken contains an empty ExternalUserId
• AccessToken contains an ExternalUserId that hasn't got the right scope to perform the required operation.

Anchor
CreateAccount CreateAccount

Create a retailer's customer account

The process to create an account could take some time. To create a new account you have to provide this information:

This method returns an activation identifier to prevent client hanging. When the method responds, your clients have to poll the activation status method to understand when the creation process ends. The response could contain domains that should be redirected to MailUp CNAMEs adding DNS records.

https://services.mailup.com/API/v1.1/Rest/RetailerService.svc/Account/

Activation/Profile/{id_Profile}/

Language/{lang}

HTTP/1.1 200 OK
 
 [
    "JA",
    "ID",
    "IT",
    "ES",
    "FR",
    "PT",
    "ZH",
    "EN"
  ]

Errors

Account

 Use these methods to manage retailer's customers accounts. With these methods you can create new accounts, add or remove packages and get what you need to login to accounts.

Note that all account resource requests need an ExternalUserId value, so you have to authenticate specifying the retailer's customer unique identifier. APIs validates client requests forbiddening the access if:

• AccessToken contains an empty ExternalUserId
• AccessToken contains an ExternalUserId that hasn't got the the right scope to perform required operation.

Create a retailer's customer account

The process to create an account could take some time. To create a new account you have to provide this information:

This method returns an activation identifier to prevent client hanging. When the method respondes, your clients has to poll the activation status method to understand when the creation process ends. The response could contains domains that should be redirect to MailUp CNAMEs adding DNS records.

{
	"IpAddress":"192.168.0.1",
	"Email":"service@retailer.it",
	"CustomDomain":"power-email-marketing.it",
	"CustomSubdomain":"customer123",
	"ServiceName":"Power email marketing",
	"ServiceUrl":"www.power-email-marketing.it/info",
	"ServiceLogoutUrl":"www.power-email-marketing.it",
	"Referer":"",
	"UserAgent: ""
}

HTTP/1.1 200 OK
 
{
	"Code":0,
	"Description":"Ok",
	"IdActivation":9054,
	"Hash":"767eed52-be08-4eb4-8658-5db4eaa215e1",
	"ControlPanelDomain":"customer123.mailadmin.io",
	"ImageTrackingDomain":"img.customer123.t.power-email-marketing.it",
	"LinkTrackingDomain":"customer123.t.power-email-marketing.it"
}

Errors

Note

1. It is possible to create ONLY ONE Trial Control Panels per ExternalUserId. If you try to create more Trials using the same ExternalUserId the response contains Code: 1, Description: Processing until the process ends, and then it contains  Code: 2, Description: Error.
2. It is possible to create MORE non Trial Control Panels per ExternalUserId. If you try to create more non Trials using the same or another ExternalUserId the response contains Code: 1, Description: Processing until the process ends, and then it contains Code: 0, Description: Ok.

Anchor
GetActivationStatus GetActivationStatus

Get retailer's customer account profile activation status

Finalize your account creation process checking its status. To finalize a new account creation process you have to provide this information:

https://services.mailup.com/API/v1.1/Rest/RetailerService.svc/Account/Activation

/{id_

Activation}/

Status

HTTP/1.1 201 Accepted
 
{
	"

Code":

1

,
	"

Description":"

Processing",
	"

IdAccount":0
}

HTTP/1.1 200 OK
 
{
	"Code":0,
	"

Description":"

Ok",
	"

IdAccount":

23052
}

HTTP/1.1 200 OK
 
{
	"Code":0,
	"Description":"Ok",
	"IdActivation":9054,
	"Hash":"767eed52-be08-4eb4-8658-5db4eaa215e1",
	"ControlPanelDomain":"customer123.mailadmin.io",
	"ImageTrackingDomain":"img.customer123.t.power-email-marketing.it",
	"LinkTrackingDomain":"customer123.t.power-email-marketing.it"
}

Errors

...

403 Forbidden

...

No profiles for the ResellerId authentication code value.

...

Code: -1

Description: Unknown account activation status.

...

Code: 2

Description: Error

...

Code: 3

Description: Language '{lang}' is not available for profile {id_Profile}.

...

Code: 4

Description: IpAddress cannot be null, empty or invalid.

...

Code: 5

Description: Email cannot be null, empty or invalid.

...

Code: 6

Description: Domains cannot be null, empty or invalid.

...

Code = 7;

Description: Custom domain not available.

...

Code: 8;

Description: Link tracking domain not available

...

Code: 9;

Description: Image tracking domain not available

...

Code: 10;

Description: Service name cannot be null, empty or invalid.

...

Code: 11;

Description: Service url cannot be null, empty or invalid.

...

Code: 12;

Description: Service logout url cannot be null, empty or invalid.

Note

1. It is possile to create ONLY ONE Trial Control Panels per ExternalUserId. If you try to create more Trial using the same ExternalUserId the response contains Code: 1, Description: Processing until the process ends and then it contains  Code: 2, Description: Error.
2. It is possile to create MORE non Trial Control Panels per ExternalUserId. If you try to create more non Trial using the same or another ExternalUserId the response contains Code: 1, Description: Processing until the process ends and then it contains Code: 0, Description: Ok.

...

Account/Activation/{id_Activation}/Status

NOTE: the id_Activation is the value returned with Create a reseller's customer account resource

...

...

...

An object (like ConsoleActivationStatusResponse object for PublicService) containing:

• Code (0: Ok, 1: Processing, 2: Error, 3: An error occurred finalizing account creation)
• Description (Ok, Processing, Error, An error occurred finalizing account creation)
• IdAccount

NOTE: the IdAccount field contains a value ONLY when the reseller's customer console is propertly created, so Code field contains the OK-CREATED code value.

NOTE2: the IdAccount equals to ConsoleId

WHEN REQUESTS RUN:

• ExternalUserId and id_Activation MUST HAVE a value
• id_Activation MUST be a numeric value

WHEN REQUESTS FAIL:

Change reseller's customer account profile

WHEN REQUESTS FAIL:

...

...

Errors

Note

1. the IdAccount field contains a value ONLY when the new account is properly created, so the Code field contains the 0 - OK code value.

Change retailer’s customer account profile

Method to change the profile. To change your account profile you have to provide this information:

https://services.mailup.com/API/v1.1/Rest/RetailerService.svc/Account/{id_Account}/Profile/{id_Profile}

Errors

Note

1. the return value is the HTTP status code of the response. API executes this operation asynchronously. Every time the client invokes the method, it returns a code. If this code tells that the operations are still in progress the resource returns a 202 Accepted status code; otherwise returns a 200 OK status code. If an error occurred it returns a 500 Internal Server Error.

2. the client can invoke the resource as many times as it wants.

Get retailer's customer account status

Method to verify the account status. To retrieve the account status you have to provide this information:

The table below shows the possible status, specifying related response fields meaning:

https://services.mailup.com/API/v1.1/Rest/RetailerService.svc/Account/{id_Account}

{
	"Code":0,
	"Description":"Enabled",
	"ActivePacks":[
		{"CurrentQuantity":0,"Id":534,"Quantity":0},
		{"CurrentQuantity":0,"Id":535,"Quantity":0},
		{"CurrentQuantity":0,"Id":536,"Quantity":0},
		{"CurrentQuantity":0,"Id":537,"Quantity":0},
		{"CurrentQuantity":0,"Id":538,"Quantity":0}
	],
	"Credits":300,
	"IdAccount":23053,
	"IdProfile":1401,
	"ValidFrom":"2015-10-14 22:00:00Z",
	"ValidTo":"2016-10-14 22:00:00Z"
}

Errors

Note

1. La chiamata ritorna -1 se il metodo GetAccountStatus dei servizi ADM ritorna come ReturnCode 1 (Processing) o 2 (Error). Tale descrizione del ReturnCode viene settata come description in modo che si possa capire il motivo del fallimento. In realtà ReturnCode, in questo caso, varrà 0 (Ok) oppure 2 (Error) e MAI 1 (Processing).
2. La proprietà ActivePacks restituisce informazioni relative allo stato attuale dei pacchetti. Il campo Quantity restituisce la somma algebrica dei pacchetti aggiunti/rimossi, mentre CurrentQuantity fornisce informazioni relative a quanti pacchetti sono attualmente in uso (un pacchetto potrebbe essere stato rimosso, ma l'effettiva rimozione avverrà a fine mese)

Disable retailer's customer account

Method to disable an account.

https://services.mailup.com/API/v1.1/Rest/RetailerService.svc/Account/{id_Account} 
or 
https://services.mailup.com/API/v1.1/Rest/RetailerService.svc/Account/{id_Account}?Enable=false

{
	"Code":0,
	"Description":"Ok"
}

Errors

Enable reseller's customer account info

...

...

Method to enable a disabled account. A disabled account cannot be enabled in the future.

https://services.mailup.com/API/v1.1/Rest/RetailerService.svc/Account/{id_

account}?Enable=true

WHEN REQUESTS FAIL:

Unprovide reseller's customer account

{
	"Code":0,
	"Description":"Ok"
}

Errors

Unprovide reseller's customer account

Method to unprovide an account. An unprovided account cannot be enabled in the future.

https://services.mailup.com/API/v1.1/Rest/RetailerService.svc/Account/{id_Account}

...

{
	"Code":0,
	"Description":"Ok"
}

Errors

...

Add the package to the retailer's customer account

...

Account/{id_Account}/Status

NOTE: the id_Account is the value returned with Get reseller's customer account profile activation status resource

...

Method to add packages to the selected account.

Http verb

Status
colour Blue title POST

Resource URLAccount/

	Required	Where	Description
id_Account	X	URL	See activation status response
id_Pack	X	URL

Request ADMTBDReturn value

An object contains these fields:

• Code (numeric)
  • 0: Enabled
  • 1: Disabled
  • 2: Unprovided
  • -1: Error or Processing
• Description (string)
  • Enabled
  • Disabled
  • Unprovided
  • Error or Processing
• ValidFrom (string, it's a DateTime)
• ValidTo (string, it's a DateTime)
• IdAccount
• Credits
• ActivePacks
  • Id
  • Quantity
  • CurrentQuantity

 

WHEN REQUESTS FAIL:

HTTP Status Code	When	Message
400 BadRequest	ExternalUserId empty.	Invalid ExternalUserId.
	ExternalUserId validation fails
403 Forbidden	Invalid Id_Account	You cannot access to provided account.

NOTE:

1. La chiamata ritorna -1 se il metodo GetAccountStatus dei servizi ADM ritorna come ReturnCode 1 (Processing) o 2 (Error). Tale descrizione del ReturnCode viene settata come description in modo che si possa capire il motivo del fallimento. In realtà ReturnCode, in questo caso, varrà 0 (Ok) oppure 2 (Error) e MAI 1 (Processing).
2. La proprietà ActivePacks restituisce informazioni relative allo stato attuale dei pacchetti. Il campo Quantity restituisce la somma algebrica dei pacchetti aggiunti/rimossi, mentre CurrentQuantity fornisce informazioni relative a quanti pacchetti sono attualmente in uso (un pacchetto potrebbe essere stato rimosso, ma l'effettiva rimozione avverrà a fine mese)

Add package to reseller's customer account

https://services.mailup.com/API/v1.1/Rest/RetailerService.svc/Account/{id_Account}/Pack/{id_Pack}

WHEN REQUESTS RUN:

• the response contains an object with:
  • Code = 0
  • Description = Ok

WHEN REQUESTS FAIL:

...

403 Forbidden

...

The package cannot be added

...

the response contains an object with:

• • Code = 1
  • Description = Quantity limits exceeded
  oppure
  • Code = 2
  • Description = Profile Rules Error

NOTE

1. Non si possono  aggiungere/rimuovere pacchetti ad un profilo TRIAL
2. Non di possono rimuovere pacchetti a consumo dai profili Economy e Premium
3. La tabella RetailerProfilePack definisce il numero di pacchetti Massimo e Minimo previsti per il profilo. La visibilità del pacchetto per l'utente finale (e quindi la sua attivabilità) è gestita con il campo IsActivable.
4. Nel caso la risposta abbia lo status code settato a 403 Forbidden si ottiene la risposta con Code=1 quando la richiesta non viene validata dai limiti previsti dalla tabella RetailerProfilePack, mentre Code=2 quando la validazione secondo i limiti della tabella retailerProfilePack è ok ma fallisce l'operazione lato ADM. Un caso in cui può essere ritornato Code=2 è quando s cerca di cancellare un pacchetto a consumo (crediti).

Get reseller's customer account logins

The resource allows to retrieve the logins available for this account/console. It is necessary if the reseller allows his customers to add more administrators to an account.

...

...

A list of AccountLogin object containing:

• idLogin
• Username

NOTE: data come from Newsletters_Login table. idLogin is the id and UserName is the username fields

...

{
	"Quantity":-3,
	"WorkMode":"incremental"
}

{
	"Quantity":3,
	"WorkMode":"absolute"
}

{
	"Code":0,
	"Description":"Ok"
}

Errors

Note

1. It is impossible to remove packages from the TRIAL profile
2. It is impossible to remove credits-related packages

Anchor
GetLogins GetLogins

Get retailer's customer account logins

The resource allows retrieving the logins available for this account/console. It is necessary if the retailer allows his customers to add more administrators to an account.

https://services.mailup.com/API/v1.1/Rest/RetailerService.svc/Account/{id_Account}/Login

{
	"IsPaginated":false,
	"Items":[
		{
			"IdLogin":45792,
			"Username":"user1"
		},
		{
			"IdLogin":45793,
			"Username":"user2"
		}],
	"PageNumber":0,
	"PageSize":20,
	"Skipped":0,
	"TotalElementsCount":2
}

https://services.mailup.com/API/v1.1/Rest/RetailerService.svc/Account/{id_Account}/Login?PageSize=2&PageNumber=1

Errors

Get

...

retailer's customer account login URL

The method provides the URL to log in to the account.

...

https://services.mailup.com/API/v1.1/Rest/RetailerService.svc/Account/{id_Account}/Login/{id_Login}

...

"http:\/\/mailup_trial.mailadmin.io\/Console\/Login.aspx?Code=2f3g3m0G2K3L1B242A1f412E0a2118373c1T1f0e1F39452a373z2P2h0n0Z3L3a2j3H2707350C3j030L3Y0O3t1A2y4032373Q3c0S2O3F1I343I0g3O0b3d050L1m-1r2K1C01041D3F013e2A0E1X3b1T3a0W1H4128020k0z0R180P053b3j1r3G152C"

none

Errors

...