IRironcladapp
Workflows

Update Custom Signature Request Status (BYOSP)

Changed on

Inbound webhook endpoint for Bring Your Own Signature Provider (BYOSP) middleware. The customer-built middleware posts signature lifecycle events here so Ironclad can update the corresponding signature request and fire workflow events.

OAuth Scope required: public.signatureRequests.updateRequest

Returns 204 No Content on success. Idempotent — once an envelope has reached completed or voided, subsequent pushes are no-ops.

patch/signature-requests/{id}

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/signature-requests/{id}
  • Auth
    API key in header Authorization and OAuth 2
    Authorization code: https://ironcladapp.com/oauth/authorize
    Client credentials
    Token URL: https://ironcladapp.com/oauth/token scopes: public.signatureRequests.updateRequest

Path parameters

idstring uuid required

The signature request (envelope) id, echoed from the initiation call.

Request body

status'pending' | 'completed' | 'voided' required

Envelope-level state. Ironclad trusts this field over signer-level inference (e.g., all signers signed but envelope still pending keeps the envelope open).

Example request

{
  "status": "completed",
  "signatures": [
    {
      "roleName": "Buyer",
      "signer": {
        "name": "Kim Lam",
        "email": "kimlam@example.com"
      },
      "status": "signed",
      "declineReason": "Counterparty requested changes to the payment terms.",
      "firstViewedAt": "2026-01-15T09:30:00Z"
    }
  ]
}

Response

204

Changes