Zatomic API

Update Scoring Criterion

This endpoint allows you to update an inidividual scoring criterion. All fields are required.

Endpoint
PATCH https://api.zatomic.ai/v1/prompts/scoring/criteria/{criteriaId}/criterionset/{criterionId}

// Example
PATCH https://api.zatomic.ai/v1/prompts/scoring/criteria/sca_2rjp9HFpIsiYQrAiSbZlz85r3GC/criterionset/scn_2tVwnAnheHa6NKuYvKcXrqDB21z

Endpoint Request

Request Properties
slug
string
The slug for the criterion. Can only contain lowercase letters and underscores.
label
string
The criterion label.
description
string
The criterion description.
questions
string
The question or questions the criterion is trying to answer.
weight
integer
The weight assigned to the criterion. Must be a whole number between 1 and 999.
Request Body
{
   "slug": "criterion_slug",
   "label": "The label of the criterion.",
   "description": "The criterion description.",
   "questions": "The question or questions the criterion is trying to answer.",
   "weight": 0
}

Endpoint Response

A successful call returns a response that contains the updated scoring criterion object.

HTTP Status Codes
200 OK The scoring criterion was updated.
400 Bad Request The criterion slug was not provided in the request.
400 Bad Request The criterion slug contained characters other than lowercase letters and underscores.
400 Bad Request The criterion label was not provided in the request.
400 Bad Request The criterion description was not provided in the request.
400 Bad Request The criterion questions were not provided in the request.
400 Bad Request The criterion weight did not have a value.
400 Bad Request The criterion weight was not a whole number between 1 and 999.
404 Not Found The scoring criterion didn't exist.
500 Internal Server Error Something went wrong on Zatomic's end.