Passer au contenu principal
POST
/
signing-requests
/
{id}
/
cancel
@firma-dev/sdk
import { FirmaClient } from "@firma-dev/sdk";

const firma = new FirmaClient({ apiKey: "YOUR_API_KEY" });

const response = await firma.signingRequests.cancelSigningRequest({
    id: "id",
    reason: "No longer needed",
    notify_signers: true
});
console.log(response);
curl --request POST \
--url https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/cancel \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"reason": "No longer needed",
"notify_signers": true
}
'
import requests

url = "https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/cancel"

payload = {
"reason": "No longer needed",
"notify_signers": True
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({reason: 'No longer needed', notify_signers: true})
};

fetch('https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'reason' => 'No longer needed',
'notify_signers' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/cancel"

payload := strings.NewReader("{\n \"reason\": \"No longer needed\",\n \"notify_signers\": true\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/cancel")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"No longer needed\",\n \"notify_signers\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"No longer needed\",\n \"notify_signers\": true\n}"

response = http.request(request)
puts response.read_body
{
  "message": "<string>",
  "signing_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cancelled_on": "2023-11-07T05:31:56Z",
  "notify_signers": true,
  "emails_sent": 123
}
{
"error": "Unauthorized",
"message": "Invalid API key"
}
{
"error": "Not Found",
"message": "The requested resource was not found"
}
{
"error": "<string>",
"message": "<string>",
"details": {}
}
{
"error": "Rate Limit Exceeded",
"message": "Too many requests. Please wait before retrying.",
"details": {
"retry_after": 45
}
}

Autorisations

Authorization
string
header
requis

Clé API pour l'authentification. Utilisez votre clé API directement sans préfixe (par exemple, 'your-api-key'). Le préfixe Bearer est optionnel mais pas obligatoire.

Paramètres de chemin

id
string<uuid>
requis

ID de la demande de signature

Corps

application/json
reason
string

Raison d'annulation optionnelle

Maximum string length: 500
notify_signers
boolean
défaut:true

Si les signataires doivent être notifiés de l'annulation

Réponse

Demande de signature annulée avec succès

Résultat de l'annulation de la demande de signature

message
string
requis
signing_request_id
string<uuid>
requis
cancelled_on
string<date-time>
requis
notify_signers
boolean
emails_sent
integer

Nombre d'emails de notification d'annulation envoyés aux signataires