Skip to main content
PUT
/
sign
/
envelopes
/
{envelopeID}
:cancel
Cancel Envelope by ID
curl --request PUT \
  --url https://api.gonitro.dev/sign/envelopes/{envelopeID}:cancel \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.gonitro.dev/sign/envelopes/{envelopeID}:cancel"

headers = {"Authorization": "Bearer <token>"}

response = requests.put(url, headers=headers)

print(response.text)
const options = {method: 'PUT', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.gonitro.dev/sign/envelopes/{envelopeID}: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.gonitro.dev/sign/envelopes/{envelopeID}:cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

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

func main() {

	url := "https://api.gonitro.dev/sign/envelopes/{envelopeID}:cancel"

	req, _ := http.NewRequest("PUT", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.gonitro.dev/sign/envelopes/{envelopeID}:cancel")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.gonitro.dev/sign/envelopes/{envelopeID}:cancel")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "ID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "lastModifiedAt": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "notification": {
    "subject": "<string>",
    "body": "<string>"
  }
}
{
  "type": "https://developers.gonitro.com/docs/build-nitro/errors#401-unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Missing or invalid Authorization header",
  "instance": "/sign/envelopes"
}
{
  "type": "https://developers.gonitro.com/docs/build-nitro/errors#404-not-found",
  "title": "Not Found",
  "status": 404,
  "detail": "Envelope with ID 'envelop-123' not found",
  "instance": "/sign/envelopes/envelop-123"
}
{
  "type": "https://developers.gonitro.com/docs/build-nitro/errors#409-conflict",
  "title": "Conflict",
  "status": 409,
  "detail": "Envelope in invalid state",
  "instance": "/sign/envelopes/%s:send-for-signing"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
envelopeID
string<uuid>
required

A unique UUIDv4 string that identifies the envelope in the Nitro system.

Response

Envelope cancelled successfully

​
ID
string<uuid>

A unique UUIDv4 string that identifies the envelope in the Nitro system.

​
createdAt
string<date-time>

UTC timestamp indicating when the envelope was created.

​
lastModifiedAt
string<date-time>

UTC timestamp indicating the last time the envelope was updated. Matches createdAt at the time of creation.

​
name
string

The name of the envelope.

​
status
enum<string>

The internal status of the envelope. Defaults to drafted on creation.

Available options:
drafted,
sent,
processing,
sealed,
rejected,
cancelled,
deleted
​
mode
enum<string>

Signing mode for the envelope.

Available options:
sequential,
parallel
​
notification
object

Notification settings for the envelope.