PUT
/
signing-requests
/
{signing_request_id}
Update Signing Request
curl --request PUT \
  --url https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{signing_request_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "document_url": "<string>",
  "page_count": 2,
  "expiration_hours": 2,
  "settings": {
    "allow_editing_before_sending": false,
    "attach_pdf_on_finish": true,
    "allow_download": true,
    "use_signing_order": true
  },
  "recipients": [
    {
      "name": "<string>",
      "email": "jsmith@example.com",
      "designation": "<string>",
      "order": 2
    }
  ]
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "status": "draft",
  "document_url": "<string>",
  "page_count": 2,
  "expiration_hours": 2,
  "settings": {
    "allow_editing_before_sending": false,
    "attach_pdf_on_finish": true,
    "allow_download": true,
    "use_signing_order": true
  },
  "created_date": "2023-11-07T05:31:56Z",
  "updated_date": "2023-11-07T05:31:56Z",
  "sent_date": "2023-11-07T05:31:56Z",
  "finished_date": "2023-11-07T05:31:56Z",
  "cancelled_date": "2023-11-07T05:31:56Z",
  "recipients": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "email": "jsmith@example.com",
      "designation": "<string>",
      "order": 2
    }
  ],
  "fields": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "signature",
      "required": false,
      "recipient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "variable_name": "<string>",
      "position": {
        "x": 123,
        "y": 123,
        "width": 2,
        "height": 2
      },
      "dropdown_options": [
        "<string>"
      ],
      "format_rules": {},
      "validation_rules": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Format: 'Bearer your-api-key'

Path Parameters

​
signing_request_id
string<uuid>
required

Body

application/json
​
name
string
required
Maximum length: 255
​
description
string
​
document_url
string<uri>
​
page_count
integer
Required range: x >= 1
​
expiration_hours
integer
Required range: x >= 1
​
settings
object
​
recipients
object[]

Response

200 - application/json

Signing request updated

​
id
string<uuid>
​
name
string
Maximum length: 255
​
description
string
​
status
enum<string>
Available options:
draft,
sent,
in_progress,
completed,
cancelled
​
document_url
string<uri>
​
page_count
integer
Required range: x >= 1
​
expiration_hours
integer
Required range: x >= 1
​
settings
object
​
created_date
string<date-time>
​
updated_date
string<date-time>
​
sent_date
string<date-time>
​
finished_date
string<date-time>
​
cancelled_date
string<date-time>
​
recipients
object[]
​
fields
object[]