Skip to main content
PUT
/
signing-requests
/
{id}
curl --request PUT \
  --url https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "signing_request_properties": {
    "name": "Updated Contract Name",
    "expiration_hours": 72
  },
  "recipients": [
    {
      "id": "rec1-e89b-12d3-a456-426614174000",
      "first_name": "John",
      "last_name": "Smith",
      "email": "john.smith@example.com",
      "designation": "Signer",
      "order": 1
    },
    {
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "jane@example.com",
      "designation": "Signer",
      "order": 2
    }
  ],
  "deleted_recipients": [
    {
      "recipient_id": "rec2-e89b-12d3-a456-426614174000",
      "field_action": "reassign",
      "reassign_to_recipient_id": "rec1-e89b-12d3-a456-426614174000"
    }
  ],
  "fields": [
    {
      "id": "field1-e89b-12d3-a456-426614174000",
      "type": "signature",
      "position": {
        "x": 15,
        "y": 85,
        "width": 30,
        "height": 10
      },
      "page_number": 1,
      "required": true,
      "recipient_id": "rec1-e89b-12d3-a456-426614174000"
    }
  ],
  "reminders": [
    {
      "hours": 48,
      "all_users": true,
      "subject": "Reminder: Please sign the document",
      "message": "This is a reminder to complete your signature."
    }
  ]
}
'
{
  "signing_request": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "document_url": "<string>",
    "document_url_expires_at": "2023-11-07T05:31:56Z",
    "document_page_count": 2,
    "status": "not_sent",
    "expiration_hours": 168,
    "settings": {
      "allow_download": true,
      "attach_pdf_on_finish": true,
      "allow_editing_before_sending": false,
      "send_signing_email": true,
      "send_finish_email": true,
      "send_expiration_email": true,
      "send_cancellation_email": true
    },
    "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "date_created": "2023-11-07T05:31:56Z",
    "date_sent": "2023-11-07T05:31:56Z",
    "date_finished": "2023-11-07T05:31:56Z",
    "date_cancelled": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "certificate": {
      "generated": true,
      "generated_on": "2023-11-07T05:31:56Z",
      "has_error": true
    },
    "final_document_download_url": "<string>",
    "final_document_download_error": "file_not_accessible"
  },
  "changes": {
    "properties_updated": true,
    "recipients_created": 123,
    "recipients_updated": 123,
    "recipients_deleted": 123,
    "fields_created": 123,
    "fields_updated": 123,
    "fields_reassigned": 123,
    "reminders_created": 123,
    "reminders_updated": 123
  }
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Path Parameters

​
id
string<uuid>
required

Signing request ID

Body

application/json
​
signing_request_properties
object

Update signing request properties

​
recipients
object[]

Upsert recipients - include 'id' to update existing recipients, use '_temp_id' (e.g., 'temp_1') for new recipients to reference them in fields and reminders within the same request

​
deleted_recipients
object[]

Recipients to delete and how to handle their fields

​
fields
object[]

Upsert fields - include id to update, omit id to create new

​
reminders
object[]

Upsert reminders - include id to update, omit id to create new

Response

Signing request updated successfully. Returns summary of changes made.

​
signing_request
object
​
changes
object