docs

Update signee details for a document

Updates signee details for an existing document.

Use Case:

Updating the contact information for a signee (without updating the document content) is typically done when the sender has entered the wrong email address or phone number, preventing the signing party from accessing the document. It could also be done when the signing party has to be delegated to/replaced by another party. When there are updates to the content required, you must instead revoke the document and send a new one.

Notes:

  • It's only possible to edit contact details, not to add new contact methods.
  • If emailAddress or phoneNumber is updated, a new document invitation will be sent to the signee with the updated contact details.
  • A new signeeId will be generated for the updated signee within this document.
  • Any previously sent document links to the old contact information will be automatically revoked to ensure security.
  • The document must not be completed or signed by the signee; otherwise, the request will fail with a 403 Forbidden error.

Cooldown Rules

  • Update Limit: A signee's contact details can only be updated a maximum of two times, before a 60-minute cooldown period applies.
  • Cooldown: After updating a signature field twice, a 60-minute cooldown period applies before another update can be made for the same signature field.
  • Checking Remaining Cooldown: The remaining cooldown time before another update is allowed is included in the response as updates.updateCooldown property in the signee details when retrieving document information via GET /docs/{documentId}.
patch/docs/{documentId}/signature-field

Request

  • Base URL: https://docs-api.formify.eu/v1
  • URL: https://docs-api.formify.eu/v1/docs/{documentId}/signature-field
  • Auth: OAuth 2 (authorization code, authorization URL https://docs-api.formify.eu/v1/oauth/authorize, token URL https://docs-api.formify.eu/v1/oauth/token)

Path parameters

documentIdstring uuid required

The unique identifier of the document.

Request body

signeeIdstring uuid

Unique identifier of the signee to update.

fullNamestring nullable

Updated full name of the signee. If null, the name remains unchanged.

emailAddressstring email nullable

Updated email address of the signee. If null, the email remains unchanged.

phoneNumberstring nullable

Updated phone number of the signee. If null, the phone number remains unchanged.

Response

Signee details updated successfully.

signeeIdstring uuid

Unique identifier of the updated signee.

updateCooldowninteger

Remaining cooldown time in seconds before another signee update can be made.

Changes

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