Partially Update Template
Changed onUpdate template properties, a single user, OR a single field. Cannot mix multiple entity types in one request. Use PUT for comprehensive updates including users, fields, and reminders. A seal_participant that names a seal answers 404 NOT_FOUND when the seal does not exist or belongs to another company, and 400 SEAL_UNAVAILABLE when the seal is revoked, deleted or not the current version of its lineage. Adding a seal participant or changing its seal answers 503 SEALS_DISABLED when organization seals are not enabled. Adding a seal participant requires order (see the order contract).
Request
- Base URLhttps://api.firma.dev/functions/v1/signing-request-api
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Request body
Example request
{
"document_id": "123e4567-e89b-12d3-a456-426614174000"
}Response
Template partially updated successfully. Updating a seal participant returns { "seal_participant": <SealParticipantApi> }.
Changes
- breaking
the response's body type changed from
objectto no type for status - breaking
removed the required property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - info
added to the response body
anyOflist for the response status
- breaking
- info
added the new optional request property
// - info
added the new optional request property
//
- info