Partners

Pause a customer

Lock sending on a customer: mailbox credentials are revoked, SMTP submissions refused, campaigns held. The same lever Faivelo's abuse controls use; you can lift your own pause with resume. Requires partner:write.

post/customers/{id}/pause

Request

  • Base URL: https://faivelo.com/api/partner
  • URL: https://faivelo.com/api/partner/customers/{id}/pause
  • Auth: HTTP bearer

Path parameters

idstring required
Example:cmtumr8yj000bd7xabjjsnil8

The customer id returned when the customer was created

Request body

reasonstring required

Example request

{
  "reason": "Client asked us to hold sending during their audit"
}

Response

Paused

successboolean

Example response

{
  "success": true
}

Changes

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