API referenceDocument Collection

Resend a request (rotates the link)

posthttps://api.expiryedge.com/v1/resendCollectionRequest
editor or admin60/minAny method
Request
curl -X POST 'https://api.expiryedge.com/v1/resendCollectionRequest?id=req_9WkT' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "skipEmail": false
}'
Response
{
  "message": "Reminder email sent",
  "email_sent": true,
  "link": "https://app.expiryedge.com/collect/3f9a1c7e5b2d4f6a8c0e1b3d5f7a9c2e4b6d8f0a1c3e5b7d9f2a4c6e8b0d1f3a"
}

Issues a new link token (the old link stops working) and emails it. With skipEmail: true no email is sent and the new link is only returned (the web app's "Copy link"). Not allowed for paused, completed or cancelled requests. The handler does not check the HTTP method.

Query parameters

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

Body parameters

application/json
  • idstring
  • skipEmailboolean
    Default false

Returns

200
Link rotated.
  • messagestringrequired
  • linkstringrequired
    The new recipient link. Treat it as a secret.
    format: uri
  • email_sentboolean
    Absent when skipEmail is true.

Errors

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.