Skip to main content
PATCH
/
api
/
agent
/
assessment-configs
/
{id}
Partially update an assessment config
curl --request PATCH \
  --url https://app.auditynow.com/api/agent/assessment-configs/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Template Name",
  "questionOrder": [
    "q1",
    "q2",
    "q3"
  ]
}
'
{
  "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": {}
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.auditynow.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

The assessment config's UUID.

Body

application/json

Partial update payload for an assessment config. At least one field must be present.

​
name
string
Required string length: 1 - 100
​
questionOrder
string[]

Ordered list of question IDs. Each entry must be a default question ID (e.g., q1, q25) or a UUID.

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})$
​
hiddenQuestions
string[]

Question IDs to hide from the survey. Each entry must be a default question ID or a UUID.

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})$
​
scoringWeights
object

Mapping of question ID to numeric weight. Values must be in [0, 10].

​
defaultQuestionOverrides
object

Per-question customizations (e.g., answer options, min/max). Total JSON size must not exceed 10 KB.

Response

Config updated

​
data
object
required

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