---
title: "Update a submitter"
method: PUT
path: "/submitters/{id}"
tags: ["Submitters"]
---

# Update a submitter

`PUT /submitters/{id}`

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="https://www.docuseal.com/guides/pre-fill-pdf-document-form-fields-with-api#automatically_sign_documents_via_api" class="link">Automatically sign documents via API</a>

## Path parameters

- `id` integer, required

## Request body

- object
  - `name` string — The name of the submitter.
  - `email` string, email — The email address of the submitter.
  - `phone` string — The phone number of the submitter, formatted according to the E.164 standard.
  - `values` object — An object with pre-filled values for the submission. Use field names for keys of the object. For more configurations see `fields` param.
  - `external_id` string — Your application-specific unique string key to identify this submitter within your app.
  - `send_email` boolean — Set `true` to re-send signature request emails.
  - `send_sms` boolean — Set `true` to re-send signature request via phone number SMS.
  - `reply_to` string — Specify Reply-To address to use in the notification emails.
  - `completed` boolean — Pass `true` to mark submitter as completed and auto-signed via API.
  - `metadata` object — Metadata object with additional submitter information.
  - `completed_redirect_url` string — Submitter specific URL to redirect to after the submission completion.
  - `require_phone_2fa` boolean — 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_2fa` boolean — Set to `true` to require email 2FA verification via a one-time code sent to the email address in order to access the documents.
  - `message` object — Custom signature request email message.
    - `subject` string — Custom signature request email subject.
    - `body` string — Custom signature request email body. Can include the following variables: {{template.name}}, {{submitter.link}}, {{account.name}}.
  - `fields` object[] — A list of configurations for template document form fields.
    - `name` string, required — Document template field name.
    - `default_value` union — Default value of the field. Use base64 encoded file or a public URL to the image file to set default signature or image fields.
      - string
      - number
      - boolean
      - union[]
        - union
          - string
          - number
          - boolean
    - `readonly` boolean — Set `true` to make it impossible for the submitter to edit predefined field value.
    - `required` boolean — Set `true` to make the field required.
    - `validation` object — Field validation rules.
      - `pattern` string — HTML field validation pattern string based on https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern specification.
      - `message` string — A custom error message to display on validation failure.
      - `min` union — Minimum allowed number value or date depending on field type.
        - number
        - string
      - `max` union — Maximum allowed number value or date depending on field type.
        - number
        - string
      - `step` number — Increment step for number field. Pass 1 to accept only integers, or 0.01 to accept decimal currency.
    - `preferences` object — Field display preferences.
      - `font_size` integer — Font size of the field value in pixels.
      - `font_type` 'bold' | 'italic' | 'bold_italic' — Font type of the field value.
      - `font` 'Times' | 'Helvetica' | 'Courier' — Font family of the field value.
      - `color` 'black' | 'white' | 'blue' — Font color of the field value.
      - `background` 'black' | 'white' | 'blue' — Field box background color.
      - `align` 'left' | 'center' | 'right' — Horizontal alignment of the field text value.
      - `valign` 'top' | 'center' | 'bottom' — Vertical alignment of the field text value.
      - `format` string — The data format for different field types.<br>- Date field: accepts formats such as DD/MM/YYYY (default: MM/DD/YYYY).<br>- Signature field: accepts drawn, typed, drawn_or_typed (default), or upload.<br>- Number field: accepts currency formats such as usd, eur, gbp.
      - `price` number — Price value of the payment field. Only for payment fields.
      - `currency` 'USD' | 'EUR' | 'GBP' | 'CAD' | 'AUD' — Currency value of the payment field. Only for payment fields.
      - `mask` union — Set `true` to make sensitive data masked on the document.
        - integer
        - boolean
      - `reasons` string[] — An array of signature reasons to choose from.

## Response `200`

OK

- object
  - `id` integer, required — Submitter unique ID number.
  - `submission_id` integer, required — Submission unique ID number.
  - `uuid` string, required — Submitter UUID.
  - `email` string, nullable, required — The email address of the submitter.
  - `slug` string, required — Unique key to be used in the form signing link and embedded form.
  - `sent_at` string, nullable, required — The date and time when the signing request was sent to the submitter.
  - `opened_at` string, nullable, required — The date and time when the submitter opened the signing form.
  - `completed_at` string, nullable, required — The date and time when the submitter completed the signing form.
  - `declined_at` string, nullable, required — The date and time when the submitter declined the signing form.
  - `created_at` string, required — The date and time when the submitter was created.
  - `updated_at` string, required — The date and time when the submitter was last updated.
  - `name` string, nullable, required — The name of the submitter.
  - `phone` string, nullable, required — The phone number of the submitter.
  - `status` 'completed' | 'declined' | 'opened' | 'sent' | 'awaiting', required — The status of signing request for the submitter.
  - `external_id` string, nullable, required — Your application-specific unique string key to identify this submitter within your app.
  - `metadata` object, required — Metadata object with additional submitter information.
  - `preferences` object, required — Submitter preferences.
  - `values` object[], required — An array of pre-filled values for the submitter.
    - `field` string, required — Document template field name.
    - `value` union, required — Pre-filled value of the field.
      - string
      - number
      - boolean
      - union[]
        - union
          - string
          - number
          - boolean
  - `documents` object[], required — An array of completed or signed documents by the submitter.
    - `name` string, required — Document name.
    - `url` string, required — Document URL.
  - `role` string, required — The role of the submitter in the signing process.
  - `embed_src` string, required — The `src` URL value to embed the signing form or sign via a link.

---

[API](https://skmtc.dev/docusealco/apis/docuseal-api.md) · [All operations](https://skmtc.dev/docusealco/apis/docuseal-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/docusealco/docuseal-api/revisions/c209c00c2386/schema)