Email Account Management APIs

Check Email Account Availability API

API to check if an email account is available for provision

get/partner/checkEmailAccountAvailability

Request

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

Query parameters

emailstring required
Example:john@doe.com

email account for which you want to check availability

titanOrderIdnumber required
Example:123

Response

OK

isAvailableboolean

<span data-no-badge></span>true implies email account is available and can be provisioned, false implies email is unavailable/already-in-use.

titanAccountIdnumber

<span data-no-badge></span>unique account id at Titan's end.

reason'EXISTS_AS_EMAIL_ACCOUNT' | 'EXISTS_AS_ALIAS_ACCOUNT' | 'EXISTS_AS_INTERNAL_FORWARDING_ACCOUNT'

<span data-no-badge></span>ONLY present when isAvailable is false, represents reason for unavailability.

Example response

{
  "isAvailable": true,
  "titanAccountId": 1,
  "reason": "EXISTS_AS_EMAIL_ACCOUNT"
}

Changes

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