Delete template - Kadoa Documentation

Archive template

curl --request DELETE \
  --url https://api.kadoa.com/v4/templates/{templateId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'DELETE', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.kadoa.com/v4/templates/{templateId}', 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.kadoa.com/v4/templates/{templateId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <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.kadoa.com/v4/templates/{templateId}"

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

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.kadoa.com/v4/templates/{templateId}")

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

request = Net::HTTP::Delete.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "error": false,
  "success": true,
  "message": "<string>",
  "unlinkedWorkflowCount": 4503599627370495
}

{
  "error": true,
  "message": "<string>",
  "details": "<unknown>"
}

{
  "error": true,
  "message": "<string>",
  "details": "<unknown>"
}

{
  "error": true,
  "message": "<string>",
  "details": "<unknown>"
}

DELETE

templates

{templateId}

Archive template

curl --request DELETE \
  --url https://api.kadoa.com/v4/templates/{templateId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'DELETE', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.kadoa.com/v4/templates/{templateId}', 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.kadoa.com/v4/templates/{templateId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <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.kadoa.com/v4/templates/{templateId}"

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

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.kadoa.com/v4/templates/{templateId}")

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

request = Net::HTTP::Delete.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "error": false,
  "success": true,
  "message": "<string>",
  "unlinkedWorkflowCount": 4503599627370495
}

{
  "error": true,
  "message": "<string>",
  "details": "<unknown>"
}

{
  "error": true,
  "message": "<string>",
  "details": "<unknown>"
}

{
  "error": true,
  "message": "<string>",
  "details": "<unknown>"
}

Authorizations

x-api-key

string

header

required

API key for authentication

Path Parameters

templateId

string<uuid>

required

Template ID

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Response

Response for template archival

error

enum<boolean>

required

Error flag (always false on success)

Available options:

false

success

enum<boolean>

required

Success flag

Available options:

true

message

string

required

Archive confirmation message

unlinkedWorkflowCount

integer

required

Number of workflows unlinked by this archive

Required range: 0 <= x <= 9007199254740991