Page Comparison

On this page:

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)

...

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
}

...

Paging and filtering (example)

...

On this page:

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.

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
}

Get retailer-defined packages by profile

To retrieve available languages you need to provide this parameter:

Errors

Note

1. Min e Max equals to the minimum and 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}/PackLang

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
 
 [
    "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.

...

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.

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

{
	"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
 
{
	"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
}

Errors

Note

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

...

 [
    "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.

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

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

{
	"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 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.

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",
	"IdActivationIdAccount":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"
}

23052
}

Errors

...

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
}

Errors

Note

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

Change reseller's customer account profile

WHEN REQUESTS FAIL:

...

...

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.

...

Note

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

Change retailer’s customer account profile

Method to change the profile. To change account 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 an 202 Accepted status code; otherwise returns a 200 OK status code. If an error occurred it returns 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}/Status

{
	"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

...

Account/{id_Account}

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

...

...

Enable reseller's customer account info

WHEN REQUESTS FAIL:

Unprovide reseller's customer 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)

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

...

Account/{id_Account}/Status

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

...

info

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

WHEN REQUESTS FAIL:

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}?Enable=true

{
	"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 package to retailer's customer account

Method to add packages to selected account.

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

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

WHEN REQUESTS RUN:

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

WHEN REQUESTS FAIL:

Errors

...

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

...