Mail Order Management APIs

Check Mail Order Reactivation Eligibility

API to check if deleted Mail Order can be reactivated.

get/partner/checkMailOrderReactivationEligibility

Request

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

Query parameters

titanOrderIdnumber required
Example:1

The unique Titan order ID against which the domain is provisioned

Response

OK

reactivationAllowedboolean

<span data-no-badge></span>

reason'DOMAIN_NOT_IN_DELETED_STATE' | 'NON_TITAN_CLOUD_DOMAIN' | 'USER_NOT_ACTIVE_IN_SYSTEM' | 'DOMAIN_PURGED' | 'ACTIVE_DOMAIN_EXISTS'

<span data-no-badge></span>This is an enum with values. This field will be present if reactivationAllowed is false

  • DOMAIN_NOT_IN_DELETED_STATE: The domain is not in a deleted state
  • NON_TITAN_CLOUD_DOMAIN: The domain is not on a Titan-managed plan, so reactivation through this API is not supported
  • USER_NOT_ACTIVE_IN_SYSTEM: The user associated with this domain is not active in the system
  • DOMAIN_PURGED: The domain's purge date has passed and it can no longer be recovered
  • ACTIVE_DOMAIN_EXISTS: Another active domain already exists with the same name

Example response

{
  "reactivationAllowed": true,
  "reason": "DOMAIN_NOT_IN_DELETED_STATE"
}

Changes

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