Remove Signature Request
Remove signature requests by their IDs. This deletes the signature requests from the signing service.
Mutation
mutation RemoveSignatureRequest($handbookId: Int!, $ids: [String!]!) {
removeSignatureRequest(handbookId: $handbookId, ids: $ids) {
success
message
}
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
handbookId | Int! | Yes | The handbook ID |
ids | [String!]! | Yes | Array of signature request IDs to remove |
Response
{
"data": {
"removeSignatureRequest": {
"success": true,
"message": "Signature requests removed successfully."
}
}
}
Examples
Remove Specific Signature Requests
First, get the IDs from getSignatureSignees:
query {
getSignatureSignees(handbookId: 123) {
signees {
id
name
email
signedAt
}
}
}
Then remove specific requests:
mutation {
removeSignatureRequest(
handbookId: 123
ids: ["456", "789"]
) {
success
message
}
}
Error Responses
No IDs Provided
{
"errors": [{ "message": "At least one ID is required" }]
}
Access Denied
{
"errors": [{ "message": "Handbook not found or access denied" }]
}
Notes
- Requires bearer token authentication
- Removes the signature requests from the signing service (Firma)
- The IDs can be obtained from the
getSignatureSigneesquery - This action cannot be undone — removed requests must be re-sent