Create a new assessment config template

Creates a new assessment configuration template. This endpoint ONLY creates templates (isTemplate is always true). Working configs are managed via the Audity UI. Returns 402 QUOTA_EXCEEDED if template limit is reached.

POST /api/agent/assessment-configs

Create a new assessment config template

cURL

curl --request POST \
  --url https://app.auditynow.com/api/agent/assessment-configs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Manufacturing Readiness Template",
  "questionOrder": [
    "q1",
    "q2",
    "q5",
    "q10"
  ]
}
'

import requests

url = "https://app.auditynow.com/api/agent/assessment-configs"

payload = {
    "name": "Manufacturing Readiness Template",
    "questionOrder": ["q1", "q2", "q5", "q10"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Manufacturing Readiness Template',
    questionOrder: ['q1', 'q2', 'q5', 'q10']
  })
};

fetch('https://app.auditynow.com/api/agent/assessment-configs', 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://app.auditynow.com/api/agent/assessment-configs",
  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([
    'name' => 'Manufacturing Readiness Template',
    'questionOrder' => [
        'q1',
        'q2',
        'q5',
        'q10'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://app.auditynow.com/api/agent/assessment-configs"

	payload := strings.NewReader("{\n  \"name\": \"Manufacturing Readiness Template\",\n  \"questionOrder\": [\n    \"q1\",\n    \"q2\",\n    \"q5\",\n    \"q10\"\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://app.auditynow.com/api/agent/assessment-configs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Manufacturing Readiness Template\",\n  \"questionOrder\": [\n    \"q1\",\n    \"q2\",\n    \"q5\",\n    \"q10\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.auditynow.com/api/agent/assessment-configs")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Manufacturing Readiness Template\",\n  \"questionOrder\": [\n    \"q1\",\n    \"q2\",\n    \"q5\",\n    \"q10\"\n  ]\n}"

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

201

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "isTemplate": true,
    "questionOrder": [
      "<string>"
    ],
    "questionCount": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "hiddenQuestions": [
      "<string>"
    ],
    "scoringWeights": {},
    "defaultQuestionOverrides": {}
  }
}

{
  "error": "<string>",
  "details": "<string>"
}

{
  "error": "Unauthorized"
}

{
  "error": "Template limit reached",
  "code": "QUOTA_EXCEEDED"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "details": "<string>"
}

Authorizations

Authorization · string · header · required

A Personal Access Token issued from https://app.auditynow.com/dashboard/settings/api-tokens. Format: aky_<32 random chars>.

Body

application/json

name · string · required

Name for this template.

Required string length: 1 - 100

questionOrder · string[] | null

Optional list of question IDs in desired order. Each entry must be a default question ID (e.g., q1, q2, q25) or a UUID. Defaults to full range if omitted.

Pattern: ^(q\d+|[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

201

application/json

Template created

data · object · required

An assessment configuration defining which questions are asked and how they are scored.

Show child attributes