--- title: Delete a subscription slug: fx-api/delete-a-subscription docTags: createdAt: 2026-03-02T04:54:16.080Z --- { "id": "P4omzZ3ORU2cEzdW5qL4j", "type": "api-oas-v2", "data": { "method": "DELETE", "url": "https://sand-api.monoova.com/au/core/notification-v1/Subscription/{subscriptionId}", "servers": [ { "url": "https://sand-api.monoova.com/au/core/notification-v1/Subscription/{subscriptionId}", "description": "Sandbox URL" }, { "url": "https://api.monoova.com/au/core/notification-v1/Subscription/{subscriptionId}", "description": "Production URL" } ], "name": "Delete a subscription", "description": "Deletes an existing webhook subscription.", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "subscriptionId", "type": "string", "description": "Monoova generated Guid to uniquely identify the subscription.", "pattern": "^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "text/plain", "application/json", "text/json" ], "default": "text/plain" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "BearerAuth", "name": "BearerAuth", "kind": "optional", "type": "http", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "SubscriptionDeleteResponse", "schema": [ { "name": "traceId", "kind": "optional", "type": "string", "nullable": true, "description": "Unique id for logging" } ], "modelRef": "#/components/schemas/SubscriptionDeleteResponse", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad Request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "traceId", "kind": "optional", "type": "string", "nullable": true, "description": "Unique id for logging" }, { "name": "errors", "kind": "optional", "type": "array", "nullable": true, "description": "", "modelRef": "#/components/schemas/ErrorDto", "customType": "ErrorDto[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "Monoova error code", "enum": [ "NOS_REQ_BODY_INVALID", "NOS_VALIDATION_ERROR", "NOS_ACCTID_REQUIRED", "NOS_TRACEID_REQUIRED", "NOS_HEADER_REQUIRED", "NOS_REQUEST_EMPTY", "NOS_SUBID_REQUIRED", "NOS_SUBID_INVALID", "NOS_SUBNAME_REQUIRED", "NOS_SUBNAME_INVALID", "NOS_ISACTIVE_REQUIRED", "NOS_EVTID_REQUIRED", "NOS_EVTNAME_REQUIRED", "NOS_EVTNAME_DISABLED", "NOS_EVTNAME_INVALID", "NOS_WEBDTL_REQUIRED", "NOS_URL_REQUIRED", "NOS_URL_INVALID", "NOS_EML_REQUIRED", "NOS_EML_INVALID", "NOS_EML_LIST_SIZE", "NOS_STS_INVALID", "NOS_PGSIZ_INVALID", "NOS_PGNUM_INVALID", "NOS_STARTDATE_INVALID", "NOS_ENDDATE_INVALID", "NOS_DATERANGE_INVALID", "NOS_DATERANGE_SIZE", "NOS_EVENT_NOT_FOUND_ERROR", "NOS_SUB_NOT_FOUND_ERROR", "NOS_DUP_SUB_CRT_ERROR", "NOS_DUP_SUB_UPD_ERROR", "NOS_DEL_SUB_ERROR", "NOS_UPD_SUB_ERROR", "NOS_UNEXPECTED_ERROR", "NOS_RETRY_NEEDED_ERROR", "NOS_MESSAGING_FAILURE_ERROR", "FX_PAYLOAD_REQUIRED", "FX_PAYLOAD_INVALID", "FX_PAYLOAD_SIGNATURE_ERROR", "FX_SIGNATURE_REQUIRED", "FX_PAYLOAD_CUSTOMERID_ERROR" ] }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "More detailed description of the specific error which may include information from the specific request." } ] } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "Unauthorized", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "traceId", "kind": "optional", "type": "string", "nullable": true, "description": "Unique id for logging" }, { "name": "errors", "kind": "optional", "type": "array", "nullable": true, "description": "", "modelRef": "#/components/schemas/ErrorDto", "customType": "ErrorDto[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "Monoova error code", "enum": [ "NOS_REQ_BODY_INVALID", "NOS_VALIDATION_ERROR", "NOS_ACCTID_REQUIRED", "NOS_TRACEID_REQUIRED", "NOS_HEADER_REQUIRED", "NOS_REQUEST_EMPTY", "NOS_SUBID_REQUIRED", "NOS_SUBID_INVALID", "NOS_SUBNAME_REQUIRED", "NOS_SUBNAME_INVALID", "NOS_ISACTIVE_REQUIRED", "NOS_EVTID_REQUIRED", "NOS_EVTNAME_REQUIRED", "NOS_EVTNAME_DISABLED", "NOS_EVTNAME_INVALID", "NOS_WEBDTL_REQUIRED", "NOS_URL_REQUIRED", "NOS_URL_INVALID", "NOS_EML_REQUIRED", "NOS_EML_INVALID", "NOS_EML_LIST_SIZE", "NOS_STS_INVALID", "NOS_PGSIZ_INVALID", "NOS_PGNUM_INVALID", "NOS_STARTDATE_INVALID", "NOS_ENDDATE_INVALID", "NOS_DATERANGE_INVALID", "NOS_DATERANGE_SIZE", "NOS_EVENT_NOT_FOUND_ERROR", "NOS_SUB_NOT_FOUND_ERROR", "NOS_DUP_SUB_CRT_ERROR", "NOS_DUP_SUB_UPD_ERROR", "NOS_DEL_SUB_ERROR", "NOS_UPD_SUB_ERROR", "NOS_UNEXPECTED_ERROR", "NOS_RETRY_NEEDED_ERROR", "NOS_MESSAGING_FAILURE_ERROR", "FX_PAYLOAD_REQUIRED", "FX_PAYLOAD_INVALID", "FX_PAYLOAD_SIGNATURE_ERROR", "FX_SIGNATURE_REQUIRED", "FX_PAYLOAD_CUSTOMERID_ERROR" ] }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "More detailed description of the specific error which may include information from the specific request." } ] } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "403", "description": "Forbidden", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "traceId", "kind": "optional", "type": "string", "nullable": true, "description": "Unique id for logging" }, { "name": "errors", "kind": "optional", "type": "array", "nullable": true, "description": "", "modelRef": "#/components/schemas/ErrorDto", "customType": "ErrorDto[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "Monoova error code", "enum": [ "NOS_REQ_BODY_INVALID", "NOS_VALIDATION_ERROR", "NOS_ACCTID_REQUIRED", "NOS_TRACEID_REQUIRED", "NOS_HEADER_REQUIRED", "NOS_REQUEST_EMPTY", "NOS_SUBID_REQUIRED", "NOS_SUBID_INVALID", "NOS_SUBNAME_REQUIRED", "NOS_SUBNAME_INVALID", "NOS_ISACTIVE_REQUIRED", "NOS_EVTID_REQUIRED", "NOS_EVTNAME_REQUIRED", "NOS_EVTNAME_DISABLED", "NOS_EVTNAME_INVALID", "NOS_WEBDTL_REQUIRED", "NOS_URL_REQUIRED", "NOS_URL_INVALID", "NOS_EML_REQUIRED", "NOS_EML_INVALID", "NOS_EML_LIST_SIZE", "NOS_STS_INVALID", "NOS_PGSIZ_INVALID", "NOS_PGNUM_INVALID", "NOS_STARTDATE_INVALID", "NOS_ENDDATE_INVALID", "NOS_DATERANGE_INVALID", "NOS_DATERANGE_SIZE", "NOS_EVENT_NOT_FOUND_ERROR", "NOS_SUB_NOT_FOUND_ERROR", "NOS_DUP_SUB_CRT_ERROR", "NOS_DUP_SUB_UPD_ERROR", "NOS_DEL_SUB_ERROR", "NOS_UPD_SUB_ERROR", "NOS_UNEXPECTED_ERROR", "NOS_RETRY_NEEDED_ERROR", "NOS_MESSAGING_FAILURE_ERROR", "FX_PAYLOAD_REQUIRED", "FX_PAYLOAD_INVALID", "FX_PAYLOAD_SIGNATURE_ERROR", "FX_SIGNATURE_REQUIRED", "FX_PAYLOAD_CUSTOMERID_ERROR" ] }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "More detailed description of the specific error which may include information from the specific request." } ] } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "404", "description": "Not Found", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "traceId", "kind": "optional", "type": "string", "nullable": true, "description": "Unique id for logging" }, { "name": "errors", "kind": "optional", "type": "array", "nullable": true, "description": "", "modelRef": "#/components/schemas/ErrorDto", "customType": "ErrorDto[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "Monoova error code", "enum": [ "NOS_REQ_BODY_INVALID", "NOS_VALIDATION_ERROR", "NOS_ACCTID_REQUIRED", "NOS_TRACEID_REQUIRED", "NOS_HEADER_REQUIRED", "NOS_REQUEST_EMPTY", "NOS_SUBID_REQUIRED", "NOS_SUBID_INVALID", "NOS_SUBNAME_REQUIRED", "NOS_SUBNAME_INVALID", "NOS_ISACTIVE_REQUIRED", "NOS_EVTID_REQUIRED", "NOS_EVTNAME_REQUIRED", "NOS_EVTNAME_DISABLED", "NOS_EVTNAME_INVALID", "NOS_WEBDTL_REQUIRED", "NOS_URL_REQUIRED", "NOS_URL_INVALID", "NOS_EML_REQUIRED", "NOS_EML_INVALID", "NOS_EML_LIST_SIZE", "NOS_STS_INVALID", "NOS_PGSIZ_INVALID", "NOS_PGNUM_INVALID", "NOS_STARTDATE_INVALID", "NOS_ENDDATE_INVALID", "NOS_DATERANGE_INVALID", "NOS_DATERANGE_SIZE", "NOS_EVENT_NOT_FOUND_ERROR", "NOS_SUB_NOT_FOUND_ERROR", "NOS_DUP_SUB_CRT_ERROR", "NOS_DUP_SUB_UPD_ERROR", "NOS_DEL_SUB_ERROR", "NOS_UPD_SUB_ERROR", "NOS_UNEXPECTED_ERROR", "NOS_RETRY_NEEDED_ERROR", "NOS_MESSAGING_FAILURE_ERROR", "FX_PAYLOAD_REQUIRED", "FX_PAYLOAD_INVALID", "FX_PAYLOAD_SIGNATURE_ERROR", "FX_SIGNATURE_REQUIRED", "FX_PAYLOAD_CUSTOMERID_ERROR" ] }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "More detailed description of the specific error which may include information from the specific request." } ] } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "500", "description": "Internal Server Error", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "4ksGheynDhA_3I4OjFyWw", "language": "curl", "label": "cURL", "code": "curl --request DELETE \\\n --url https://sand-api.monoova.com/au/core/notification-v1/Subscription/{subscriptionId} \\\n --header 'accept: text/plain'" }, { "id": "JwfZEKIdo-KB3_9s2yDad", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"text/plain\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'DELETE',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://sand-api.monoova.com/au/core/notification-v1/Subscription/{subscriptionId}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "z4BnkufqPfY1KS3-bqoMP", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://sand-api.monoova.com/au/core/notification-v1/Subscription/{subscriptionId}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Delete.new(url)\nrequest[\"accept\"] = \"text/plain\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "6MQr5paTuvTMRQzPFlEZ-", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://sand-api.monoova.com/au/core/notification-v1/Subscription/{subscriptionId}\"\n\npayload = {}\nheaders = {\n 'accept': 'text/plain',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"DELETE\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "4ksGheynDhA_3I4OjFyWw" }, "results": { "languages": [ { "id": "egFac4AV0SvZ817GCQ9CM", "language": "200", "code": "// OK\n{\n \"traceId\": \"\"\n}" }, { "id": "NFW6Rtu1yfOXs60YinhRw", "language": "400", "code": "// Bad Request\n{\n \"traceId\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n }\n ]\n}" }, { "id": "n6QIsjJdz1ME7cJ__Wub3", "language": "401", "code": "// Unauthorized\n{\n \"traceId\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n }\n ]\n}" }, { "id": "rYp2RDeiXpGFU0C0Ga7N2", "language": "403", "code": "// Forbidden\n{\n \"traceId\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n }\n ]\n}" }, { "id": "xmKtMRWBN0emvdq_rl9f0", "language": "404", "code": "// Not Found\n{\n \"traceId\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n }\n ]\n}" }, { "id": "rQ-lLrZ52U2OHpAhnKlMd", "language": "500", "code": "// Internal Server Error\n" } ], "selectedLanguageId": "egFac4AV0SvZ817GCQ9CM" } }, "children": [ { "text": "" } ] }