Forms

Move, resend or cancel a form request

visitAt moves the visit, and with it the send time of a request not yet sent and the expiry. resend: true sends the same link again. cancel: true cancels. Nothing here makes a second submission.

patch/v1/form-requests/{formRequestId}

Request

  • Base URL: https://sign-api.tvarka.pro
  • URL: https://sign-api.tvarka.pro/v1/form-requests/{formRequestId}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key
    • OAuth 2 (authorization code, authorization URL https://sign-api.tvarka.pro/oauth/authorize, token URL https://sign-api.tvarka.pro/oauth/token, scopes: sign.read, sign.signings)

Path parameters

formRequestIdstring uuid required

Request body

visitAtstring date-time
sendAtstring date-time
expiresAtstring date-time
resendboolean
cancelboolean

Response

The request after the change.

formRequestIdstring uuid required
referencestring required
status'scheduled' | 'sent' | 'opened' | 'in_progress' | 'submitted' | 'completed' | 'expired' | 'cancelled' | 'failed' required
channel'remote' | 'walk_in' | 'kiosk' required
externalIdstring nullable
templateVersionIdsstring[] required
visitAtstring date-time nullable
sendAtstring date-time nullable
expiresAtstring date-time nullable
sentAtstring date-time nullable
openedAtstring date-time nullable
submittedAtstring date-time nullable
completedAtstring date-time nullable
createdAtstring date-time required
valuesobject

Present once submitted. Values by semantic identifier.

Changes

No recorded changes to this operation across all 1 revision of this API.