API Documentation Download OpenAPI specification

Create Email Account

POSThttps://bll.titan.email/partner/createEmailAccount

API to create an email account for a Mail Order on the Titan Mail Cloud infra

Body

application/json
titanOrderIdnumberrequired

The unique order ID against each domain provisioned with Titan

Example: 1
orderIdstring

The order ID stored on your end for this mail order, if any. If needed, You can use this data to correlate orders at your end and in Titan.The data is returned in listMailOrders call.

Example: partner.order.id
emailstringrequired

Email account to be created within Titanmail.

Example: james@xyz.com
namestringoptional

The name of the customer for whom the email address is being created. This is used if firstName and lastName are not provided.

Example: James Bond
firstNamestringoptional

The first name of the customer for whom the email address is being created.

Example: James
lastNamestringoptional

The last name of the customer for whom the email address is being created.

Example: Bond
alternateEmailAddressstringoptional

Alternate email address on which the customer can be contacted

Example: james@gmail.com
passwordstringoptional

Password to be set for the email account entered by end customer on partner website

Example: qwe123
requireAutoLoginTokenbooleanoptional

Partner specifies whether they need an auto login token.

Example: true
isAdminbooleanoptional

Specifies whether or not the user is an admin

Example: true
sendWelcomeEmailbooleanoptional

Specifies whether or not to send email to customer for this newly created email-account. Default value of this flag is false

Example: true
localestringoptional
Example: en-gb
sourcestringoptional
Example: standalone

Responses

200OKapplication/json
reqIDstringrequired
Example: server.req.id
titanAccountIdnumberrequired

The unique mail account ID against each email provisioned with Titan

Example: 1
webmailAutoLoginTokenstring

Response from Titans end. Titan passes you a short term auto login token to redirect customer to Titanmail. Check here to see How to use this token

Example: adfadfweqwe
400MAX_POP_ACCOUNT_LIMIT_REACHED
  • unable create account, when tries to create account but domain has N active account and plan only allows N active accounts.
See General Errors for other errors that this API can return.
POST/partner/createEmailAccount
curl https://bll.titan.email/partner/createEmailAccount \
  --request POST \
  --header 'Authorization: API.Key' \
  --header 'Content-Type: application/json' \
  --data '{
  "titanOrderId": 1,
  "orderId": "partner.order.id",
  "email": "james@xyz.com",
  "name": "James Bond",
  "firstName": "James",
  "lastName": "Bond",
  "alternateEmailAddress": "james@gmail.com",
  "password": "qwe123",
  "requireAutoLoginToken": true,
  "isAdmin": true,
  "sendWelcomeEmail": true,
  "locale": "en-gb",
  "source": "standalone"
}'
Response
{
  "reqID": "server.req.id",
  "titanAccountId": 1,
  "webmailAutoLoginToken": "adfadfweqwe"
}