Skip to main content

Updating Participant Contact Info

This use case describes how to update the delivery methods or contact information (email/phone) for a participant in an active signing session.

Overview​

There are several scenarios where you might need to update a participant's contact details:

  • The participant's email address has changed.
  • The participant did not receive the initial invitation due to a typo.
  • You need to add or change the SMS delivery method.
  • The participant specifically requested a different contact method.

Important Restrictions​

  • Status: Updates are only allowed for participants in Pending status.
  • Link Usage: You cannot update contact info after the participant has already opened their signing link.
  • Security: When contact info is updated, the previous signing link is invalidated and a new one is generated for security reasons.

The Update Process​

To update a participant, you need both the signingSessionId and the participantId.

Endpoint: PUT /api/signingSessions/{signingSessionId}/participants/{participantId}

Example: Changing to Email Delivery​

If a participant was originally set for SMS and you want to switch to Email:

Request:

{
  "deliveryMethods": ["Email"],
  "email": "participant@newcompany.com",
  "phone": null
}

Example: Adding SMS as a Delivery Method​

If you want the participant to receive invitations via both Email and SMS:

Request:

{
  "deliveryMethods": ["Email", "Sms"],
  "email": "participant@example.com",
  "phone": "2025559999"
}

What Happens After the Update?​

  1. System Updates Info: The participant's record is updated with the new email/phone.
  2. Signing link Regeneration: A fresh signing link is generated for the participant.
  3. New Invitation: The system automatically sends a new invitation using the updated delivery methods.
  4. Invalidation: The old signing link (if any) becomes invalid immediately.

Common Errors​

Possible error messages (for more info look at examples)

Error Message
Delivery method can't be changed because the participant has already used the signing link.
The session is in a status (e.g., Expired) that does not allow updating participant info.
The participant has already completed the signing process.
The provided email address format is invalid.
Communication was rejected because the phone number is opted out of SMS messages.
The specified Signing Session or Participant was not found.