Skip to main content
POST
/
v1
/
recurring
/
{scheduleId}
/
pause
Pause Recurring Schedule
curl --request POST \
  --url https://api.peere.network/v1/recurring/{scheduleId}/pause \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'
{
  "statusCode": 200,
  "success": true,
  "message": "Recurring schedule paused successfully",
  "data": {
    "scheduleId": "<string>",
    "status": "paused",
    "pausedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

scheduleId
string
required

Body

application/json
reason
string

Response

Recurring schedule paused successfully

statusCode
integer
Example:

200

success
boolean
Example:

true

message
string
Example:

"Recurring schedule paused successfully"

data
object