ProductSearchCTIX

Network live

CTIXPOST

Create Custom Object

POSThttps://cs-testv2.cyware.com/ctixapi/ingestion/configuration/custom-object/

Creates a custom object by providing valid data.

Body Parameters

Name	Type	Required	Description
name	string	required	Pass a name for the custom object.
description	string	optional	Pass a description for the custom object.
fields	array	required	Pass a list of JSON objects for each custom attribute to add to the custom object.

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 POST

Open API (HMAC signature) · Get credentials from Cyware Admin → Open API → Generate Credentials.

Base URL

Access ID *Secret Key *

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.

Request body (JSON)Valid JSON

cURL

curl --request POST \
  --url "https://cs-testv2.cyware.com/ctixapi/ingestion/configuration/custom-object/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E" \
  --data '{
  "name": "Credit Card",
  "description": "sample 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/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E";

const response = await fetch(url, {
  method: "POST",
  headers: {},
  body: JSON.stringify({
    "name": "Credit Card",
    "description": "sample 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/"
params = {
    "AccessID": "<your access id>",
    "Signature": "<your signature>",
    "Expires": "<your expires>"
}
headers = {}
payload = {
  "name": "Credit Card",
  "description": "sample description",
  "fields": [
    {}
  ]
}
response = requests.request("POST", 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": "sample 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": 1633093577,
  "status": 1,
  "manual": true,
  "fields": [
    {}
  ]
}

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