Update template

curl --request PUT \
  --url https://api.kadoa.com/v4/templates/{templateId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'

import requests

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

payload = {
    "name": "<string>",
    "description": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', description: '<string>'})
};

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 => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\"\n}")

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

	req.Header.Add("x-api-key", "<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.put("https://api.kadoa.com/v4/templates/{templateId}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\"\n}")
  .asString();

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::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\"\n}"

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

{
  "error": false,
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "latestVersion": 123,
    "archivedAt": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "workflowCount": 123,
    "latestVersionSummary": {
      "promptPreview": "<string>",
      "schemaFieldNames": [
        "<string>"
      ],
      "dqRuleCount": 0,
      "notificationChannelCount": 0,
      "frequencyInterval": "ONLY_ONCE",
      "frequencyWeekdaysOnly": true
    }
  }
}

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

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

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

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

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

PUT

templates

{templateId}

Update template

curl --request PUT \
  --url https://api.kadoa.com/v4/templates/{templateId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'

import requests

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

payload = {
    "name": "<string>",
    "description": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', description: '<string>'})
};

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 => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\"\n}")

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

	req.Header.Add("x-api-key", "<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.put("https://api.kadoa.com/v4/templates/{templateId}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\"\n}")
  .asString();

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::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\"\n}"

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

{
  "error": false,
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "latestVersion": 123,
    "archivedAt": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "workflowCount": 123,
    "latestVersionSummary": {
      "promptPreview": "<string>",
      "schemaFieldNames": [
        "<string>"
      ],
      "dqRuleCount": 0,
      "notificationChannelCount": 0,
      "frequencyInterval": "ONLY_ONCE",
      "frequencyWeekdaysOnly": true
    }
  }
}

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

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

{
  "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})$

Body

application/json

Body

Request body for updating a template

name

string

Updated name

Required string length: 1 - 255

description

string | null

Updated description

Maximum string length: 2000

Response

Response for template update

error

enum<boolean>

required

Error flag (always false on success)

Available options:

false

success

enum<boolean>

required

Success flag

Available options:

true

data

TemplateResponse · object

required

Template object response

Show child attributes