API-ReferenzDocument Collection

Pause a request

posthttps://api.expiryedge.com/v1/pauseCollectionRequest
editor or admin60/minJede Methode
Anfrage
curl -X POST 'https://api.expiryedge.com/v1/pauseCollectionRequest?id=req_9WkT' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY"
Antwort
{
  "message": "Request paused"
}

The link returns 403 until resumed and reminders are skipped. Only pending or viewed requests can be paused. The handler does not check the HTTP method.

Query-Parameter

  • idstring
    Request id (or id in the body).

Rückgabe

200
Success.
  • messagestringerforderlich

Fehler

400
The request is missing required fields or contains invalid values.
401
Missing, expired or invalid bearer token.
403
Your role does not allow this, or the record belongs to another organization ({"error": "Access denied"}).
404
The record does not exist or is not in your organization.
429
Too many requests for this endpoint from your IP. Wait Retry-After seconds.