Skip to content

API reference

Set signing deadline

signing.SetSigningDeadlineWriteAPI key

Change a pending signing session's deadline and notify remaining signers. Existing links and signatures stay valid. An unchanged deadline sends no notifications.

POST/v1/operations/signing.SetSigningDeadline
On this page

Access & visibility

Allow signing.SetSigningDeadline on your API key.

Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.

Set up authentication · Choose permissions

Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.

signing_request_idstringRequired

Keep the signing_request_id returned when invitations were requested. A file_id or signer_id identifies something else. signing.RequestFileSignatures.

At least 1 character. At most 120 characters.

expires_atintegerRequired

New deadline in Unix milliseconds, in the future. Brigg presents the deadline as an inclusive date in Europe/Oslo; use the end of that local day (23:59:59.999), converted to an epoch timestamp.

Follow one signing request through completion

Upload a readable PDF, then request signatures and keep signing_request_id. The request keeps a fixed source; replacing the original file later does not change what recipients sign.

Read Get signing request for per-recipient progress. completed means everyone signed, but the archive can still be preparing: wait for non-null file_id before requesting the signed PDF. Get signing document returns a short-lived URL for either the fixed original or the signed archive.

Notification failures do not undo the signing request. Remind the affected pending recipients instead of creating a duplicate request. Recipients sign themselves; a delegated API call cannot supply a recipient's signature. See the complete signing workflow.

Response

Returns 200 OK with a JSON body.

signing_request_idstringRequired

Signing request identifier.

expires_atnumberRequired

Signing deadline in Unix milliseconds.

previous_expires_atnumberRequired

Deadline before this update, in Unix milliseconds.

notifiedarray of stringRequired

Whether remaining recipients were notified of the deadline change.

notice_failuresarray of stringRequired

Deadline-change notifications that could not be delivered.

Errors & retries

Set BRIGG_REQUEST_ID once for each logical action. The samples send it as Idempotency-Key. Reuse the same value and body on retries, including after a timeout; a missing response does not prove the action failed.

For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.

HTTP status Code What to do
400 invalid_json Send a JSON object with Content-Type: application/json.
400 invalid_input Check the request fields and types. Supply a stable Idempotency-Key containing 1–200 characters.
401 invalid_key The workspace API key is missing, invalid or revoked.
403 forbidden Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member.
404 not_found The requested operation or resource is not available to this credential.
429 rate_limited Wait for Retry-After before retrying. Reuse the original Idempotency-Key.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema
{
  "type": "object",
  "properties": {
    "signing_request_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120,
      "description": "Keep the signing_request_id returned when invitations were requested. A file_id or signer_id identifies something else. [signing.RequestFileSignatures](/reference/signing/RequestFileSignatures)."
    },
    "expires_at": {
      "type": "integer",
      "description": "New deadline in Unix milliseconds, in the future. Brigg presents the deadline as an inclusive date in Europe/Oslo; use the end of that local day (23:59:59.999), converted to an epoch timestamp."
    }
  },
  "required": [
    "signing_request_id",
    "expires_at"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "signing_request_id": "e_example",
      "expires_at": 1794301200000
    }
  ]
}
Full response JSON schema
{
  "type": "object",
  "properties": {
    "signing_request_id": {
      "type": "string",
      "description": "Signing request identifier."
    },
    "expires_at": {
      "type": "number",
      "description": "Signing deadline in Unix milliseconds."
    },
    "previous_expires_at": {
      "type": "number",
      "description": "Deadline before this update, in Unix milliseconds."
    },
    "notified": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Whether remaining recipients were notified of the deadline change."
    },
    "notice_failures": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Deadline-change notifications that could not be delivered."
    }
  },
  "required": [
    "signing_request_id",
    "expires_at",
    "previous_expires_at",
    "notified",
    "notice_failures"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "signing_request_id": "e_example",
      "expires_at": 1794301200000,
      "previous_expires_at": 1794301200000,
      "notified": [],
      "notice_failures": []
    }
  ]
}

Search by operation name or what you want to build.

Use arrow keys to browse. Enter opens a result.