FIfirma
Signing Requests

Comprehensive Update Signing Request

Changed on

Perform comprehensive updates to a signing request including properties, recipients, fields, and reminders. Cannot update after signing request has been sent, completed, or cancelled. All sections are optional but at least one must be provided.

Temporary ID Pattern for New Recipients: When adding new recipients in a comprehensive update, use the 'temp_id' field (format: 'temp_X') instead of 'id' to establish relationships with fields and reminders. This allows you to create new recipients and reference them in fields/reminders in a single request. Use the 'id' field to update existing recipients. Validation rules: (1) Temporary IDs must start with 'temp'; (2) Each temporary ID must be unique within the request; (3) Fields and reminders can reference temporary IDs in their recipient_id property; (4) The API will automatically resolve temporary IDs to real UUIDs after recipient creation.

put/signing-requests/{id}

Request

Path parameters

idstring uuid required

Signing request ID

Request body

force_remove_conditionsboolean

When deleting recipients whose fields are referenced by conditions in other fields: if true, automatically remove the condition references; if false (default), the request will be rejected with an error listing the dependent fields.

language'en' | 'es' | 'it' | 'pt' | 'fr' | 'de' | 'el' | 'ru' | 'pl' | 'cs' | 'sv' | 'nl' | 'ro' | 'nb' | 'ca' nullable

Opt-in email language for this signing request. When set, all signer-facing emails (and their date formatting) use it. Omit or null to fall back to the workspace, then company, default language (unchanged behavior).

documents_layout_versioninteger

The documents_layout_version of your last read (multi-document). Required for a field write on a signing request with more than one document or a layout version above 1 (409 DOCUMENTS_LAYOUT_VERSION_REQUIRED); a stale value answers 409 DOCUMENT_SET_VERSION_CONFLICT; a value that is not a non-negative integer answers 400 VALIDATION_ERROR with key documents_layout_version.

Example request

{
  "fields": [
    {
      "format_rules": {
        "dateFormat": "MMMM dd, yyyy"
      },
      "background_color": "#FFFDE7"
    }
  ]
}

Response

Signing request updated successfully. Returns the updated signing request and summary of changes made.

idstring uuid required

Signing request ID (for backward compatibility)

namestring required

Signing request name (for backward compatibility)

Changes

  • 3a2cdde3a64fRevision changes
    • info

      added the new optional request property //

    • info

      added the new optional request property //

  • bfc2b19c9c7eRevision changes
    • info

      added the new optional request property

    • info

      added the non-success response with the status