CTIX
Network live
CTIXPUT

Update Custom Object

Source docs
PUThttps://cs-testv2.cyware.com/ctixapi/ingestion/configuration/custom-object/{custom_object_id}/

Updates the details of a custom object.

Path Parameters

NameTypeRequiredDescription
custom_object_idstringrequired

Pass the unique ID of a custom object.

Body Parameters

NameTypeRequiredDescription
namestringoptional

Pass a name for the custom object.

descriptionobjectoptional

Pass a description for the custom object.

fieldsarrayoptional

Pass a list of JSON objects for each custom attribute to add to the custom object.

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.

CTIXConnect to Intel ExchangeRequired to change data
Credentials required for PUT

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.

Path Parameters
Request body (JSON)Valid JSON
cURL
curl --request PUT \
  --url "https://cs-testv2.cyware.com/ctixapi/ingestion/configuration/custom-object/3e2b320-f9d0-4ae8-ab6d-f72c50283a0f/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E" \
  --data '{
  "name": "Credit Card",
  "description": {},
  "fields": [
    {}
  ]
}'

View-only example — running live API calls requires a role with snippet testing access.

JavaScript
const url = "https://cs-testv2.cyware.com/ctixapi/ingestion/configuration/custom-object/3e2b320-f9d0-4ae8-ab6d-f72c50283a0f/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E";

const response = await fetch(url, {
  method: "PUT",
  headers: {},
  body: JSON.stringify({
    "name": "Credit Card",
    "description": {},
    "fields": [
      {}
    ]
  }),
});

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.

Python
import requests

url = "https://cs-testv2.cyware.com/ctixapi/ingestion/configuration/custom-object/3e2b320-f9d0-4ae8-ab6d-f72c50283a0f/"
params = {
    "AccessID": "<your access id>",
    "Signature": "<your signature>",
    "Expires": "<your expires>"
}
headers = {}
payload = {
  "name": "Credit Card",
  "description": {},
  "fields": [
    {}
  ]
}
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.

Request Body
{
  "name": "Credit Card",
  "description": {},
  "fields": [
    {}
  ]
}

View-only example — running live API calls requires a role with snippet testing access.

Example Response
{
  "id": "a3e2b320-f9d0-4ae8-ab6d-f72c50283a0f",
  "name": "Credit Card",
  "type": "x-credit-card",
  "description": {},
  "ctix_created": 1633093577,
  "ctix_modified": 1633106876,
  "status": 1,
  "manual": true,
  "fields": [
    {}
  ]
}

View-only example — running live API calls requires a role with snippet testing access.