Skip to main content

Reseller API: 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​

ParameterTypeRequiredDescription
handbookIdInt!YesThe handbook ID
ids[String!]!YesArray 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 reseller API key authentication
  • The handbook must belong to a customer of the authenticated reseller
  • Removes the signature requests from the signing service (Firma)
  • The IDs can be obtained from the getSignatureSignees query
  • This action cannot be undone — removed requests must be re-sent