Email Account Management APIs

Create Email Account

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

post/partner/createEmailAccount

Request

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

Request body

titanOrderIdnumber required

The unique order ID against each domain provisioned with Titan

orderIdstring

<span data-no-badge></span>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.

emailstring required

Email account to be created within Titanmail.

namestring

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

firstNamestring

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

lastNamestring

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

alternateEmailAddressstring

Alternate email address on which the customer can be contacted

passwordstring

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

requireAutoLoginTokenboolean

Partner specifies whether they need an auto login token.

isAdminboolean

Specifies whether or not the user is an admin

sendWelcomeEmailboolean

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

localestring
sourcestring

Example request

{
  "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

OK

reqIDstring required
titanAccountIdnumber required

The unique mail account ID against each email provisioned with Titan

webmailAutoLoginTokenstring

<span data-no-badge></span>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 response

{
  "reqID": "server.req.id",
  "titanAccountId": 1,
  "webmailAutoLoginToken": "adfadfweqwe"
}

Changes

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