v1

latestOpenAPI 3.1.02026-07-14220425.8 KB

Submitters

Update a submitter

The API endpoint allows you to update submitter details, pre-fill or update field values and re-send emails.<br><b>Related Guides</b><br><a href="/keyring-guides/pre-fill-pdf-document-form-fields-with-api.html#automatically_sign_documents_via_api" class="link">Automatically sign documents via API</a>

put/submitters/{id}

Path parameters

idinteger required

The unique identifier of the submitter.

Request body

namestring

The name of the submitter.

emailstring email

The email address of the submitter.

phonestring

The phone number of the submitter, formatted according to the E.164 standard.

valuesobject

An object with pre-filled values for the submission. Use field names for keys of the object. For more configurations see fields param.

external_idstring

Your application-specific unique string key to identify this submitter within your app.

send_emailboolean

Set true to re-send signature request emails.

send_smsboolean

Set true to re-send signature request via phone number SMS.

reply_tostring

Specify Reply-To address to use in the notification emails.

completedboolean

Pass true to mark submitter as completed and auto-signed via API.

metadataobject

Metadata object with additional submitter information.

completed_redirect_urlstring

Submitter specific URL to redirect to after the submission completion.

require_phone_2faboolean

Set to true to require phone 2FA verification via a one-time code sent to the phone number in order to access the documents.

require_email_2faboolean

Set to true to require email 2FA verification via a one-time code sent to the email address in order to access the documents.

Example request

{
  "email": "john.doe@example.com",
  "phone": "+1234567890",
  "fields": [
    {
      "name": "First Name",
      "validation": {
        "pattern": "[A-Z]{4}"
      },
      "preferences": {
        "font_size": 12,
        "format": "DD/MM/YYYY",
        "price": 99.99
      }
    }
  ]
}

Response

idinteger required

Submitter unique ID number.

submission_idinteger required

Submission unique ID number.

uuidstring required

Submitter UUID.

emailstring nullable required

The email address of the submitter.

slugstring required

Unique key to be used in the form signing link and embedded form.

sent_atstring nullable required

The date and time when the signing request was sent to the submitter.

opened_atstring nullable required

The date and time when the submitter opened the signing form.

completed_atstring nullable required

The date and time when the submitter completed the signing form.

declined_atstring nullable required

The date and time when the submitter declined the signing form.

created_atstring required

The date and time when the submitter was created.

updated_atstring required

The date and time when the submitter was last updated.

namestring nullable required

The name of the submitter.

phonestring nullable required

The phone number of the submitter.

status'completed' | 'declined' | 'opened' | 'sent' | 'awaiting' required

The status of signing request for the submitter.

external_idstring nullable required

Your application-specific unique string key to identify this submitter within your app.

metadataobject required

Metadata object with additional submitter information.

preferencesobject required

Submitter preferences.

rolestring required

The role of the submitter in the signing process.

embed_srcstring required

The src URL value to embed the signing form or sign via a link.