API Documentation Download OpenAPI specification

Transfer Mail Order

POSThttps://bll.titan.email/partner/transferMailOrder
  • Transfer Mail Order from one customer account to another
  • If a titan user profile for the new customerId does not already exist a new profile will be created using information passed or else order will be moved to the existing titan user profile.
  • Customer profile should be in the active state.
  • The order's status can be anything (active, suspended, ...)
  • serverHostName will be only applicable for partners using Titan's cPanel/plesk plugins.

Body

application/json
titanOrderIdnumberrequired

The unique order ID against each domain provisioned with Titan

Example: 1
transferToobjectoptional
Show propertiesHide properties
customerIdstringrequired

Unique ID on your side for this customer

Example: titanuser
customerNamestringoptional

Customer name

Example: Titan User
customerEmailAddressstringrequired

Customer email address All communications will be sent here This will also be the primary admin for the domain

Example: titanuser@titan.mail
customerCountrystringoptional

Customer country, 2 letter ISO Code

Example: US
serverHostNamestringoptional

hostname of the hosting-server where user's hosting order has been provisioned It's expected that only 1 server is registered with the given hostname. API fails if there are multiple

Responses

200OKapplication/json
reqIDstringrequired
Example: server.req.id
400BAD_REQUEST
  • domain customer is not in active state.
See General Errors for other errors that this API can return.
POST/partner/transferMailOrder
curl https://bll.titan.email/partner/transferMailOrder \
  --request POST \
  --header 'Authorization: API.Key' \
  --header 'Content-Type: application/json' \
  --data '{
  "titanOrderId": 1,
  "transferTo": {
    "customerId": "titanuser",
    "customerName": "Titan User",
    "customerEmailAddress": "titanuser@titan.mail",
    "customerCountry": "US",
    "serverHostName": "string"
  }
}'
Response
{
  "reqID": "server.req.id"
}