Resend Contract Invitation Email

Resend contract signing invitation email

Resends the UrbanPay-branded signing invitation to the current active
link-delivery signer. This is a client dashboard Owner/Operations action
(403 if called via an API credential). Rate-limited to once per minute
per participant (429 if called again too soon). Returns 404 if the
request or participant is not found. Returns 400 if the request or
participant has reached a terminal status, the participant is not the
current active signer, the participant isn't link-delivery, or the
participant has no email/signing URL on file.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Resend the UrbanPay-branded signing invitation email to a signer whose turn it is to sign. Use this when a signer reports they never received (or lost) their original invitation. The endpoint re-sends the email to the signer's existing address and signing link, records the new attempt, and returns the updated contract request.

Authentication & access

  • Requires a client API token: Authorization: Bearer <token>.
  • API credentials need the contracts.requests.write permission. Dashboard users need the OWNER or OPERATIONS role, or a custom role that includes this permission.
  • This is a dashboard-only action: a request made with an API credential returns 403, even when the credential has the contracts.requests.write permission. Only a signed-in dashboard user can resend an invitation.
  • Contract signing must be enabled for the client. If it is disabled the request returns 403.

Path parameters

  • request_id - the contract request whose signer should be re-invited. Must belong to your client.
  • participant_id - the participant (signer) to re-invite. Must belong to the given request.

Preconditions

The targeted participant must be the one who can currently receive an invitation email:

  • The contract request must not be in a terminal state (completed, canceled, declined, or expired).
  • The participant must not be in a terminal state.
  • The participant must be signing right now: a member of the current signing stage. When signers sign in parallel, each unfinished member of the current group qualifies. You cannot re-invite a signer whose turn has not yet come or has already passed.
  • The signer must use link delivery. Signers configured for other delivery methods cannot receive invitation emails.
  • The signer must have both an email address and a signing URL on file.

A precondition failure returns 400.

Rate limiting

A 60-second cooldown applies per signer, counted from the last invitation attempt for that signer, including the automatic invitation sent when their turn started. If you call this endpoint again for the same signer within 60 seconds of that attempt, the request returns 429. Wait for the cooldown to elapse and retry.

Response

200 - the invitation email was sent. The payload is the updated contract request, reflecting the new send attempt on the targeted participant (invitation_email_status, invitation_email_sent_at, invitation_email_last_attempt_at, invitation_email_attempt_count).

Error responses

StatusWhen
400Request is terminal; participant is terminal; participant is not signing right now; signer is not link-delivery; signer is missing an email address or signing URL
403Contract signing is disabled for the client; or the request was made with an API credential instead of a dashboard user
404Contract request not found under this client, or participant not found on the request
502The signing invitation email could not be delivered

Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.

Path Params
string
required
string
required
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json