Updates a custom score.
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| custom_score_id | string | optional | Pass the ID of a custom score to update. |
Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | optional | Returns the unique identifier of the custom score. |
| name | string | optional | Pass the name of the custom score. |
| api_key | string | optional | Returns the internal identifier used for referencing the custom score in APIs or automation. |
| helptext | string | optional | Pass the help text for the custom score. |
| field_type | string | optional | Returns the field type of the custom score. |
| values | array | optional | Pass the array of values for the custom score. Required if the field type is a single select list. |
| is_deprecated | boolean | optional | Pass true to set the custom score as deprecated, else false. |
Run it
Use the Request parameters panel to enter path IDs, query values, JSON body, and credentials. Then run any snippet below — all languages use the same values. Base URL: https://cs-testv2.cyware.com/ctixapi (change in API Settings).
Playground
Request parameters
Edit values here before running any snippet below (cURL, JavaScript, or Python). Code blocks are reference only — your inputs above are what gets sent.
Open API (HMAC signature) · Get credentials from Cyware Admin → Open API → Generate Credentials.
Signature and Expires are generated when you run a request. Access ID and Secret Key stay in memory for this tab only.
Credentials from Authentication auto-fill here for this product. If fields are empty after connecting, refresh this page or open the product docs again.
curl --request PUT \
--url "https://cs-testv2.cyware.com/ctixapi/conversion/custom-score/x_ctix_customscore_1/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E" \
--data '{
"id": "c7f0ee98-6c0f-4653-9345-a457e3e2deb5",
"name": "Score",
"api_key": "x_ctix_customscore_4",
"helptext": "NA",
"field_type": "select",
"values": [
"High"
],
"is_deprecated": false
}'View-only example — running live API calls requires a role with snippet testing access.
const url = "https://cs-testv2.cyware.com/ctixapi/conversion/custom-score/x_ctix_customscore_1/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E";
const response = await fetch(url, {
method: "PUT",
headers: {},
body: JSON.stringify({
"id": "c7f0ee98-6c0f-4653-9345-a457e3e2deb5",
"name": "Score",
"api_key": "x_ctix_customscore_4",
"helptext": "NA",
"field_type": "select",
"values": [
"High"
],
"is_deprecated": false
}),
});
const text = await response.text();
let data;
try { data = JSON.parse(text); } catch { data = text; }
console.log(response.status, data);View-only example — running live API calls requires a role with snippet testing access.
import requests
url = "https://cs-testv2.cyware.com/ctixapi/conversion/custom-score/x_ctix_customscore_1/"
params = {
"AccessID": "<your access id>",
"Signature": "<your signature>",
"Expires": "<your expires>"
}
headers = {}
payload = {
"id": "c7f0ee98-6c0f-4653-9345-a457e3e2deb5",
"name": "Score",
"api_key": "x_ctix_customscore_4",
"helptext": "NA",
"field_type": "select",
"values": [
"High"
],
"is_deprecated": false
}
response = requests.request("PUT", url, params=params, headers=headers, json=payload)
print(response.status_code)
print(response.text)View-only example — running live API calls requires a role with snippet testing access.
{
"id": "c7f0ee98-6c0f-4653-9345-a457e3e2deb5",
"name": "Score",
"api_key": "x_ctix_customscore_4",
"helptext": "NA",
"field_type": "select",
"values": [
"High"
],
"is_deprecated": false
}View-only example — running live API calls requires a role with snippet testing access.
{
"message": "CustomScore updated successfully"
}View-only example — running live API calls requires a role with snippet testing access.