Trigger electronic signature for a mandate
POST/api/v1/mandates/:id/trigger_signature
Sends the mandate to the signature provider for electronic signature. Sets the mandate signature_status to pending (does not change the mandate state). If the signature is already pending, the pending request is first cancelled at the signature provider, or confirmed already closed there (cancelled, expired or declined), before a new one is opened. When it can be neither cancelled nor confirmed closed, no new request is opened and the mandate's pending signature request is left as it is.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
The mandate was sent to the signature provider for electronic signature; signature_status is now pending. The mandate's own state is unchanged.
Missing, invalid, or expired OAuth 2.0 bearer token.
The OAuth access token does not include the scope required for this operation.
No mandate with this ID exists, or it belongs to a tenant the authenticated OAuth application cannot access.
The signature could not be triggered: the mandate is not in the incomplete state, it is already signed (remove the signed document first), signer_email is missing (and none is set on the mandate), the signature provider request itself failed, the pending signature request could not be cancelled at the signature provider, the pending signature request has already been signed at the signature provider (it is not replaced; the signature is recorded when the provider reports it), the mandate terms changed while the signature request was being prepared (Scribee asks the signature provider to withdraw the new request), or the mandate's signature request changed in the meantime (a concurrent trigger or cancel, or a signed document attached meanwhile).
rate_limited: a signature trigger limit was reached. Nothing was rendered and the signature provider was not asked. The limits: per mandate, 3 requests per hour; per workspace, 5 requests per minute and 60 requests per hour; per OAuth application, across every workspace it reaches, 5 requests per minute and 60 requests per hour; per workspace and signer email address (case and any +tag ignored), 20 requests per day. A refused call counts only against the limits it exceeded. Retry-After is an upper bound: each window opens at the first call it counts, so it may close sooner.
Response Headers
Seconds to wait before retrying: the longest period among the limits the call exceeded. An upper bound, since that window opened at the first call it counted.