Eliminar documento programado
curl --request DELETE \
--url https://api.tupana.ai/v1/scheduled-documents/{id} \
--header 'Authorization: <api-key>'import requests
url = "https://api.tupana.ai/v1/scheduled-documents/{id}"
headers = {"Authorization": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: '<api-key>'}};
fetch('https://api.tupana.ai/v1/scheduled-documents/{id}', 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.tupana.ai/v1/scheduled-documents/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$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.tupana.ai/v1/scheduled-documents/{id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.tupana.ai/v1/scheduled-documents/{id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tupana.ai/v1/scheduled-documents/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"error": "VALIDATION_ERROR",
"message": "<string>"
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}Documentos Programados
Eliminar documento programado
Elimina un documento programado existente.
DELETE
/
scheduled-documents
/
{id}
Eliminar documento programado
curl --request DELETE \
--url https://api.tupana.ai/v1/scheduled-documents/{id} \
--header 'Authorization: <api-key>'import requests
url = "https://api.tupana.ai/v1/scheduled-documents/{id}"
headers = {"Authorization": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: '<api-key>'}};
fetch('https://api.tupana.ai/v1/scheduled-documents/{id}', 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.tupana.ai/v1/scheduled-documents/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$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.tupana.ai/v1/scheduled-documents/{id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.tupana.ai/v1/scheduled-documents/{id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tupana.ai/v1/scheduled-documents/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"error": "VALIDATION_ERROR",
"message": "<string>"
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}Qué hace
- Elimina un documento programado existente de forma permanente
- Remueve el documento programado del sistema
- No afecta los documentos ya emitidos que fueron generados por este documento programado
- Esta acción no se puede deshacer
- Requiere que el documento programado pertenezca a tu entidad
Ejemplos de uso
- Eliminar un documento programado que ya no se necesita
- Remover documentos programados obsoletos o con errores de configuración
- Limpiar documentos programados que han completado todas sus ejecuciones
- Eliminar documentos programados de prueba o desarrollo
- Remover documentos programados que se crearon por error
Notas importantes
- ⚠️ Esta acción es permanente: Una vez eliminado, el documento programado no podrá ser recuperado
- Solo puedes eliminar documentos programados que pertenezcan a tu entidad
- La eliminación no afecta los documentos ya emitidos que fueron generados por este documento programado
Endpoints relacionados
- Listar Documentos Programados - Ver todos los documentos programados
- Obtener Documento Programado - Ver detalles antes de eliminar
- Crear Documento Programado - Crear un nuevo documento programado
- Listar Documentos - Consultar documentos ya emitidos por este documento programado
Authorizations
API Key para autenticación. Debe proporcionarse en el header Authorization con el formato: 'Api-Key YOUR-API-KEY' (incluye el prefijo 'Api-Key ' seguido de tu API key)
Path Parameters
ID del documento programado
Example:
789
Query Parameters
ID de la entidad maestra
Example:
123
Response
Documento programado eliminado exitosamente
