Versions Compared

Old Version 20

changes.mady.by.user MailUp Dev Team

Saved on

compared with

New Version 21

changes.mady.by.user MailUp Dev Team

Saved on

Key

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

On this page:

...

  • 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:

...

Description

Create a retailer's customer account

HTTP Method

POST

URL

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

JSON request (example)

Expand
Code Block
{
	"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: ""
}

JSON response (example)

Expand
Code Block
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"
}

Paging and filtering (example)

none

Errors

HTTP Status CodeWhenMessage
400 BadRequestUnexisting lang value into the TwoLetterISOLanguageName list.Invalid language.
ExternalUserId empty.Invalid ExternalUserId.

403 Forbidden


 

No profiles for the ResellerId authentication code value.

You cannot access to provided profile.
Internal error occurred

Code: -1

Description: Unknown account activation status.

You are not able to create this account

Code: 2

Description: Error

Language provided is not allowed for this retailer's edition

Code: 3

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

IpAddress is null, empty or IPAddress.TryParse fails

Code: 4

Description: IpAddress cannot be null, empty or invalid.

IpAddress is null, empty or EmailHelper.ValidateAddress fails

Code: 5

Description: Email cannot be null, empty or invalid.

Request contains some null, empty or invalid domain fields

Code: 6

Description: Domains cannot be null, empty or invalid.

One or more domains not available

Code = 7;

Description: Custom domain not available.

Code: 8;

Description: Link tracking domain not available

Code: 9;

Description: Image tracking domain not available

Invalid retailer's service information

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.

...

  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

...

Account/Activation/{id_Activation}/Status

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

...

 RequiredWhere
id_ActivationXURL

...

 RequiredWhoWhere
id_ActivationXGiven by ResellerRequest API

...

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:

HTTP Status CodeWhenMessage
400 BadRequestExternalUserId empty.Invalid ExternalUserId.
ExternalUserId validation fails
id_Activation is not a numberInvalid activation.

 

Change reseller's customer account profile

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

 RequiredWhereDescription
id_ActivationXURLSee create account

Description

Get retailer's customer account profile activation status

HTTP Method

GET

URL

Code Block
https://services.mailup.com/API/v1.1/Rest/RetailerService.svc/Account/Activation/{id_Activation}/Status

JSON request (example)

none

JSON response (example)

Expand

System is creating your new account:

Code Block
HTTP/1.1 201 Accepted
 
{
	"Code":1,
	"Description":"Processing",
	"IdAccount":0
}

 

New account create succesfully:

Code Block
HTTP/1.1 200 OK
 
{
	"Code":0,
	"Description":"Ok",
	"IdAccount":23052
}

 

 

Paging and filtering (example)

none

Errors

HTTP Status CodeWhenMessage
400 BadRequestExternalUserId empty.Invalid ExternalUserId.
ExternalUserId validation fails
id_Activation is not a numberInvalid activation.

403 Forbidden

Unknown account activation status phase

 

Code = -1

Description = Unknown account activation status

Account activation failed

Code = 2

Description = Error

Link or image tracking domains, service name, url or logout url cannot be set

Code = 3

Description = An error occurred finalizing account creation

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.

 

Http verb
Status
colourYellow
titlePUT
Resource URL

Account/{id_Account}/Profile/{id_Profile}

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

Request API
 RequiredWhere
id_AccountXURL
id_ProfileXURL
Request ADM
 RequiredWhoWhere
id_AccountXGiven by ResellerRequest API
id_ProfileXGiven by ResellerRequest API
Return value

-

NOTE: the return value is the HTTP Status code of the response. ADM executes this operation asynchronously. Every time the reseller invokes the resource, ADM 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.

NOTE 2: the reseller can invoke the resource as many times as it wants.

 

Change reseller's customer account profile

WHEN REQUESTS FAIL:

HTTP Status CodeWhenMessage
400 BadRequestExternalUserId empty.Invalid ExternalUserId.
ExternalUserId validation fails

...

Http verb
Status
colourYellow
titlePUT
Resource URL

Account/{id_Account} or Account/{id_Account}?Enable=false

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

Request API
 RequiredWhere
id_AccountXURL
Enable Querystring
Request ADMNone
Return value

The resource returns a 200 OK status code and and object containing account status properties.

In detail the returned object actually contains:

    • Code: int value corresponding to the account status code
      • 0: Active
      • 1: Deactivated
    • Description: human readable description of the account status code
      • Active
      • Deactivated
    • ValidFrom: String corresponding to the validity start date
    • ValidTo: String corresponding to the validity end date

WHEN REQUESTS FAIL:

HTTP Status CodeWhenMessage
400 BadRequestExternalUserId empty.Invalid ExternalUserId.
ExternalUserId validation fails

...

Http verb
Status
colourYellow
titlePUT
Resource URL

Account/{id_Account} or Account/{id_Account}?Enable=true

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

Request API
 RequiredWhere
id_AccountXURL
Enable XQuerystring
Request ADMNone
Return value

The resource returns a 200 OK status code and and object containing account status properties.

In detail the returned object actually contains:

  • Code: int value corresponding to the account status code
    • 0: Active
    • 1: Deactivated
  • Description: human readable description of the account status code
    • Active
    • Deactivated
  • ValidFrom: String corresponding to the validity start date
  • ValidTo: String corresponding to the validity end date

WHEN REQUESTS FAIL:

HTTP Status CodeWhenMessage
400 BadRequestExternalUserId empty.Invalid ExternalUserId.
ExternalUserId validation fails

...

Http verb
Status
colourRed
titleDELETE
Resource URL

Account/{id_Account}

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

Request API
 RequiredWhere
id_AccountXURL
Request ADMTBD
Return valueThe resource returns a 200 OK status code.

WHEN REQUESTS FAIL:

HTTP Status CodeWhenMessage
400 BadRequestExternalUserId empty.Invalid ExternalUserId.
ExternalUserId validation fails

...

Http verb
Status
colourBlue
titlePOST
Resource URL

Account/{id_Account}/Pack/{id_Pack}

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

Request API
 RequiredWhere
id_AccountXURL
id_PackXURL
QuantityXBody
WorkModeXBody

WorkMode should be "incremental" or "absolute" and refers to the way to manage packages.

The "incremental" work mode allows client to add or remove packages as defined by Quantity field. If client calls the method 3 times with quantity equals to 1, API method adds 1 package each time. If client needs to remove a package it calls the method with quantity equals to -1 and API method removes a package.

The "absolute" work mode allows client to define the total number of packages.If client calls the method with quantity equals to 4, API method adds 4 packages. If client needs to remove 2 packages from the current quantity (set to 4 by the previews call) it calls the method with quantity equals to 2 and the API method removes 2 packages.

NB: "absolute" work mode allows only unsigned value for Quantity.

 

Request ADM
 RequiredWhoWhere
id_AccountXGiven by ResellerRequest API
id_PackXGiven by ResellerRequest API
Return value

In detail the returned object actually contains:

  • Code: int value corresponding to the account status code
    • 0: Ok
    • 1: Quantity_limits_exceeded
    • 2: Profile_rules_error
    • 3: Invalid_quantity
    • 4: Invalid_workmode
  • Description: human readable description of the account status code
    • Ok
    • Quantity limits exceeded
    • Profile rules error
    • Invalid quantity
    • Invalid workmode

NOTE: the resource returns a 200 OK status code if the package was added succesfully and the response contains code = 0; if the addition does not end propertly, the resource returns a 403 Forbidden and the response contains code = 1

WHEN REQUESTS RUN:

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

...