Redirection between Partner and Titan

Embedding Titan iframe control panel within Partner environment

iFrame Source URL : https://manage.titan.email/partner/cpWidget?partnerId=<PARTNER_ID>&jwt=<JWT_TOKEN>&section=<section>&action=<action>&email=<email>&locale=<supported-Titan-language>&theme=<registered-theme-name>

  • Pass attribute allow="clipboard-write" in iframe tag to allow copy functionality in embedded control panel e.g <iframe src=${iframe_url} allow="clipboard-write" />.

Read the Titan control panel events that you can listen to, to create a richer experience with Titan's iframe and the partner environment.

Parameters

  • partnerId (string, required)
  • jwt (string, required)
    • Jwt Request Body
          {
          "titanOrderId": 123,
          "exp": 345678974327
          }
      
    • titanOrderId (number, required)
      • The unique Titan order ID against which the domain is provisioned
    • exp (number, required)
  • section (string, optional)
    • Control panel Section to open, Specify the section within the control panel to be loaded
      • home (default)
      • email-accounts
      • internal-forward
      • catch-all-email
      • device-download
      • configure-desktop
      • domain-verification
      • import-email
      • billing-and-upgrade
      • buy-email-account
      • billing-and-subscription
  • action (string, optional)
    • launch-email-creation used with email-accounts section
    • paymentSuccess used with billing-and-upgrade section
    • reactivate-subscription used with billing-and-subscription section
  • email (string, optional)
    • required with launch-email-creation action
  • locale (string, optional)
    • Specifies the language to be set within the Email Control Panel. List of support Titan languages - link Default is en-us
  • theme (string, optional)
    • Specifies the theme to be loaded in iframe for a partner.
    • The value needs to be registered first with Titan alongwith theme related customizations.
    • If value is not registered or not specified, default theme for partner is rendered in embedded iframe.
get/partner/cpWidget

Request

  • Base URL: https://bll.titan.email
  • URL: https://bll.titan.email/partner/cpWidget
  • Auth: none declared

Query parameters

partnerIdstring required
Example:PARTNER_ID
jwtstring required
Example:JWT_TOKEN
section'home' | 'email-accounts' | 'internal-forward' | 'catch-all-email' | 'device-download' | 'configure-desktop' | 'domain-verification' | 'import-email' | 'billing-and-upgrade' | 'buy-email-account' | 'billing-and-subscription'
Example:home

Control panel Section to open, Specify the section within the control panel to be loaded

actionstring
Example:launch-email-creation
emailstring
Example:james@xyz.com
localestring
Example:en-us

Specifies the language to be set within the Email Control Panel. List of support Titan languages - link Default is en-us

themestring
Example:partner-theme

Specifies the theme to be loaded in iframe for a partner. The value needs to be registered first with Titan alongwith theme related customizations. If value is not registered or not specified, default theme for partner is rendered in embedded iframe.

Response

Returns iframe content

Changes

No recorded changes to this operation across all 1 revision of this API.