Sign in
collect.sessions

Request a new collect session link

Sends the current active link when possible, or creates a new session for an expired token. The recipient comes from the session itself, so no body is needed. Always returns 202 to prevent enumeration.

post/collect/sessions/{token}/request-link

Path parameters

tokenstring required

The expired collect session token

Example:cs_live_cmll8jh7b00013b6tlu7lvntw

Response

Request accepted

successboolean required
maskedEmailstring nullable required

Masked address the new link was sent to, if one was sent

Example response

{
  "success": true,
  "maskedEmail": "c***@example.com"
}

Changes

Changed in 2 of the 5 revisions of this API.25

  • 80748f72965e1See the full diff
    • ○

      added the media type application/json for the response with the status 500

      response-media-type-added

  • 5e60a1f6e88a24See the full diff
    • ▲

      removed the request body

      request-body-removed

    • ▲

      the response's body type/format changed from / to object/ for status 422

      response-body-type-changed

    • ○

      removed subschema #1 subschema #2 from the response body anyOf list for the response status 422

      response-body-any-of-removed

    • ○

      added the required property error to the response with the 422 status

      response-required-property-added

    • ○

      added the required property maskedEmail to the response with the 202 status

      response-required-property-added

    • ○

      added the required property success to the response with the 422 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog