Mail Order Management APIs

Suspend Mail Order

API to suspend an existing Mail Order provisioned on Titan Mail Cloud infra on non-payment. On suspension:

  • Titan will suspend any orders associated with the domain name
post/partner/suspendMailOrder

Request

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

Request body

titanOrderIdnumber required

The unique order ID against each domain provisioned with Titan

suspensionTypestring required

Reason for the suspension (e.g. abuse, expiry, or any custom value). Use expiry for non-renewal suspensions — only expiry suspensions are automatically lifted when the order renews. All other suspension types must be removed manually.

notestring

Any internal description / ticket ID, visible in the parter-panel only to the partners support team. This is so that more info is communicated, and the next agent knows what to do with this case.

sourcestring

Optional identifier for what triggered the suspension, recorded for reporting and analytics. When omitted, it defaults to partner_api_suspension_order.

Example request

{
  "titanOrderId": 1,
  "suspensionType": "abuse",
  "note": "any internal description just for reference",
  "source": "partner_api_suspension_order"
}

Response

OK

reqIDstring required

Example response

{
  "reqID": "server.req.id"
}

Changes

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