Mail Order Management APIs

Check Mail Order Availability

API to check a mail order with given domainName is available for provisioning on Titan

Availability behaviour

  • isAvailable: true — the domain is available for the requesting partner to create a mail order.
  • isAvailable: false — the requesting partner already has an order for this domain; its details are returned in the response (titanOrderId, customerDetails, orderDetails).
  • The same domain can have a mail order under multiple partners, but only one of those orders is serviceable at a time; the others are non-serviceable. Even when the domain is already serviceable under a different partner, this API returns true and the partner can still create an order — it is created in a non-serviceable state.
    • Serviceable — all email services are allowed.
    • Non-serviceable — email services are not allowed, but the user can still log in to their account.
  • To make the order serviceable, the user must prove ownership of the domain. Once ownership is verified, an automated status-switch job makes the order serviceable and moves the previously serviceable order to non-serviceable — no manual action is required.
  • Titan is updating its mail interfaces to guide users on how to prove domain ownership, making this state easier to understand.
get/partner/checkMailOrderAvailability

Request

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

Query parameters

domainNamestring required
Example:domainname.com

name of domain

Response

OK

isAvailableboolean

<span data-no-badge></span>true implies domain is available and can be provisioned, false implies domain name is already-in-use and a new order with the same name cannot be provisioned.

titanOrderIdnumber

<span data-no-badge></span>In case if the order using given domain name is provisioned by you, this will contain its titanOrderId. If not provisioned by you then this field will not be present.

Example response

{
  "isAvailable": true,
  "titanOrderId": 1,
  "customerDetails": {
    "titanCustomerId": 123,
    "customerId": "customer",
    "customerEmail": "customer@domain.com"
  },
  "orderDetails": {
    "noOfAccounts": 1000,
    "createdAt": 1645315200000,
    "expiryDate": "2022-02-20",
    "planType": "pro",
    "status": "active",
    "source": "source"
  }
}

Changes

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