Mail Order Management APIs

Toggle Mail Service

This API is relevant if you are using Titan's cPanel plugin.<br/> Using this api, You can choose to move all domains from Titan cloud to cPanel local (or vice versa) for a particular cPanel account. Calling this api would result in deleting all the existing domain orders within that cPanel account and recreating them with the selected mail service. The action will be applied to all existing domains and all future domains added within the cPanel account. All domains in a cPanel account can either be on local or titan at a given point in time. This will not result in any migration of email accounts, email data or dns; those will need to be handled by you separately.

post/partner/toggleMailService

Request

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

Request body

titanOrderIdnumber required

The unique order ID against each domain provisioned with Titan

mailService'titan' | 'local' required

Desired mail service to which customer wants to move

mode'single_domain' | 'all_domains'

toggling strategy, default is all_domains

Example request

{
  "titanOrderId": 1,
  "mailService": "titan",
  "mode": "all_domains"
}

Response

OK

reqIDstring required

Example response

{
  "reqID": "server.req.id"
}

Changes

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