Schedule suspension

POST p8auth/subscribers/{id}/schedule/suspension

Example Request

POST /api/v1/p8auth/subscribers/1/schedule/suspension HTTP/1.1
Host: tph.io
X-Token: c9c0a840-b5f1-4e0e-84da-e8a4eedfc63b
Content-Type: application/json

{
  "suspend_at":"2018-04-20",
  "should_delete":false
}

Response Structure

  • success: bool
  • messages: string
  • data: object
    • data: object
      • id: int
      • subscriber_id: int
      • suspend_at: string ("2020-01-01T00:00:00+00:00")
      • delete_at: string ("2020-01-01T00:00:00+00:00")

Example Response

{
  "success": true,
  "messages": "Suspension scheduled.",
  "data": {
    "data": {
      "id": 1,
      "subscriber_id": 1,
      "suspend_at": "2018-04-20T00:00:00+00:00",
      "delete_at": null
    }
  }
}