post https://{host}/api_gateway/cortex/v1/neo-config
This API allows you to enable the custom event transformation logic for your org. At a time, only one config per entity can be enabled for an org.
Note
For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .
Prerequisites
- Authentication: Basic/OAuth authentication
- Default access group
Resource Information
| URI | /api_gateway/cortex/v1/neo-config |
| HTTP method | POST |
| Pagination | NA |
| Rate limit | Default |
| Batch support | NA |
API Endpoint Example
https://eu.api.capillarytech.com//api_gateway/cortex/v1/neo-config
Request Body
{
"orgId": 100737,
"entityType": "TRANSACTION",
"transformEndpoint": "/transform/transaction/custom",
"active": true
}
{
"orgId": 100737,
"entityType": "CUSTOMER",
"transformEndpoint": "/transform/customer/custom",
"active": true
}
Request Body Parameters
| Parameter | Type | Description |
|---|---|---|
| orgId* | long | Your organisation ID |
| entityType* | string | Entity type for this configuration (Spported Entities: "CUSTOMER", "TRANSACTION"). |
| transformEndpoint* | string | The NEO endpoint path for the transformation service. |
| active | boolean | Defines if the configuration is active. Supported values: true , false . To deactivate a config, you can set this to false and execute the API again. |
Response Body
{"data":{"orgId":100737,"entityType":"TRANSACTION","transformEndpoint":"/transform/transaction/custom","active":true,"auditInfo":{"createdOn":"2025-04-23T06:59:56.411+00:00","createdBy":75155282,"lastUpdatedOn":"2025-04-23T07:06:33.947+00:00","lastUpdatedBy":75155282}},"errors":[]}
Response Parameters
| Parameter | Data type | Description |
|---|---|---|
orgId | long | The ID of the organization (e.g., 100737). |
entityType | string | The type of entity the configuration applies to (e.g., TRANSACTION). |
transformEndpoint | string | The endpoint used for transformation of the entity data. |
active | boolean | Indicates whether the configuration is currently active (true or false). |
auditInfo.createdOn | date | Timestamp when the configuration was created in ISO 8601 format. |
auditInfo.createdBy | long | User ID of the person who created the configuration. |
auditInfo.lastUpdatedOn | date | Timestamp when the configuration was last updated in ISO 8601 format. |
auditInfo.lastUpdatedBy | long | User ID of the person who last updated the configuration. |
errors | A list of errors, if any (empty in this case). |
API Error Codes
| Error code | Description |
|---|---|
| 400 BAD_REQUEST | - The request body is invalid JSON - Required fields are missing - The request body fails validation - Constraint violations occur |
| 401 UNAUTHORIZED | - Authentication is missing or invalid - The auth token is not provided |
| 403 FORBIDDEN | - The authenticated user doesn't have permission to create configurations |
| 500 INTERNAL_SERVER_ERROR | - Unexpected server errors occur - Database operations fail - Other runtime exceptions occur |