generateMyAccountUrl

Generates link to My Account box. Through the optional parameter modules you can customize it.

📘

You can try that method by clicking here

Parameters

Name

Type

Description

publisherToken*

string

Your publisher Token. Only for enterprise accounts.

customerEmail*

string

Customer's email

modules

array

Needed modules (profile, payment, subscriptions, transactions, affiliate-tracking, consents-list)

Result Parameters

Name

Type

Description

url

string

URL to My Account

API Request/Response

Request

{
  "method": "generateMyAccountUrl",
  "params": {
    "publisherToken": "JuVCIAjsOckpwjDs88O0flkVt8IRFl0jDNv9IzXAsYhYRfQ7",
    "customerEmail": "[email protected]",
    "modules": [
      "profile",
      "payment",
      "subscriptions"
    ]
  },
  "jsonrpc": "2.0",
  "id": 1
}

Response

{
  "result": {
    "url": "https:\/\/myaccount.cleeng.com\/youroffername?order=profile%2Cpayment%2Csubscriptions&remote_token=1a432f373e37cd8542ed8acd40fe2c69ckd8a048%3Ac9b162a390905a90a7c638b131b6ae02cb8d6eza"
  },
  "id": "1",
  "jsonrpc": "2.0"
}

Error Codes

Code

Description

3

Invalid publisher token

10

Invalid email address

16

Invalid module list