Sample Response for Invalid request format
{
    "response_id": "jyNoAPhO",
    "type": "custom_segment",
    "error": {
        "code": "Invalid request",
        "message": "Invalid request format. Please check the documentation to ensure that the request has been formed correctly."
    }
}
Sample Response for Invalid db-name/app-key
{
    "response_id": "FkrgtCVr",
    "type": "custom_segment",
    "error": {
        "code": "Request Error",
        "message": "MoEngage Client not found. Please check values for headers - MOE-APPKEY or MOE-DBNAME"
    }
}
Sample Response for when there are HTML characters that are not allowed or only whitespaces in custom-segment name present in the request
    "response_id": "XtVyUnlJ",
    "type": "custom_segment",
    "error": {
        "code": "Invalid Request",
        "message": "Invalid request. Please ensure that the filters are correct and the custom-segment name doesn't contain HTML characters/only whitespaces."
    }
}

Sample Response for when a forbidden operation is present in the request
{
    "response_id": "xuLAWeCN",
    "type": "custom_segment",
    "error": {
        "code": "Forbidden operation",
        "message": "Update isn't supported for file-segments, internally created custom-segments, custom-segments imported from Analyze and archived custom-segments."
    }
}

Sample Response for when the custom-segment id used in the request doesn’t exist
{
    "response_id": "UAMMfmuU",
    "type": "custom_segment",
    "error": {
        "code": "Entity Not Found",
        "message": "Custom segment not found with the given id: 638a051185b6b50a018cacc"
    }
}

Sample Response for when another custom-segment already exists with the same name
{
    "response_id": "wSiiqYRr",
    "type": "custom_segment",
    "error": {
        "code": "Resource not created",
        "message": "Another custom-segment already exists with the same name: api_test_8. Please change the custom-segment name."
    }
}
Sample Response for when another custom-segment already exists containing the same filters
{
    "response_id": "GMpZHlxp",
    "type": "custom_segment",
    "error": {
        "code": "Resource not created",
        "message": "Another custom-segment already exists containing the given filters: api_cycle_1. Please reuse the same or update the filters",
        "existing_cs_name": "api_cycle_1",
        "existing_cs_id": "638a051185b6b50a018cacc1"
    }
}

Sample Response for attempt to create a cyclic custom-segment
{
    "response_id": "acOcgPed",
    "type": "custom_segment",
    "error": {
        "code": "Cyclic Entity",
        "message": "Circular reference detected in the custom segment definition."
    }
}

Sample Response for when there is another custom-segment already exists with the same name
{
    "response_id": "wSiiqYRr",
    "type": "custom_segment",
    "error": {
        "code": "Resource not created",
        "message": "Another custom-segment already exists with the same name: api_test_8. Please change the custom-segment name."
    }
}
Sample Response for when another custom-segment already exists containing the same filters.
{
    "response_id": "GMpZHlxp",
    "type": "custom_segment",
    "error": {
        "code": "Resource not created",
        "message": "Another custom-segment already exists containing the given filters: api_cycle_1. Please reuse the same or update the filters",
        "existing_cs_name": "api_cycle_1",
        "existing_cs_id": "638a051185b6b50a018cacc1"
    }
}

Sample Response for when there is too much nesting of custom-segments
{
    "response_id": "dDvgyvHX",
    "type": "custom_segment",
    "error": {
        "code": "Query has too many nesting levels",
        "message": "The query has more than n levels of nesting. Please reduce the segment nesting."
    }
}
Sample Response for too many custom-segments referenced in the current query
{
    "response_id": "uQPqruXM",
    "type": "custom_segment",
    "error": {
        "code": "Too many segments in a query",
        "message": "The query has more than n custom segments. Please reduce the custom segments."
    }
}
Sample Response for too many filters in the current query.
{
    "response_id": "dcAqEczX",
    "type": "custom_segment",
    "error": {
        "code": "Query length limit exceeded",
        "message": "The query is too large to execute. Please reduce the filters."
    }
}

Sample Response for Rate Limit Breach
{
    "response_id": "OUUkHvcn",
    "type": "custom_segment",
    "error": {
        "code": "Too Many Requests",
        "message": "API rate limit breached. Current limit: n/m mins"
    }
}

Sample Response for server side errors
{
    "response_id": "HKWwUkvM",
    "type": "custom_segment",
    "error": {
        "code": "Internal Server Error",
        "message": "An unexpected error was encountered while processing this request. Please contact MoEngage Team"
    }
}