---
title: Update a subscription
slug: fx-api/update-a-subscription
docTags:
createdAt: 2026-03-02T04:54:16.080Z
---
{
"id": "4uBJ8iaPCKboy7hvwagai",
"type": "api-oas-v2",
"data": {
"method": "PUT",
"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": "Update a subscription",
"description": "Creates a new webhook subscription.",
"contentType": "application/json-patch+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": [
{
"kind": "optional",
"name": "body",
"type": "object",
"description": "",
"customType": "SubscriptionDetailCreateDto",
"schema": [
{
"name": "subscriptionName",
"kind": "required",
"type": "string",
"description": "User-Defined name, to make the purpose or owner clear. Name provided by customers only.
",
"pattern": "^[-\\w]{1,36}$"
},
{
"name": "eventName",
"kind": "required",
"type": "string",
"description": "The event we are subscribing to.",
"enum": [
"FXTransactionStatusChangedNotification"
]
},
{
"name": "webHookDetail",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/WebHookDetailDto",
"customType": "WebHookDetailDto",
"schema": [
{
"name": "callBackUrl",
"kind": "required",
"type": "string",
"description": "URL of your server.\n\nMust be a well formed URI."
},
{
"name": "securityToken",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "This token will be sent back with the callback in Authorization header.
\nWhen creating the token, both 'type' and 'credentials' are required.
"
}
]
},
{
"name": "isActive",
"kind": "required",
"type": "boolean",
"description": ""
}
],
"modelRef": "#/components/schemas/SubscriptionDetailCreateDto",
"isExpanded": true
}
],
"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": "SubscriptionUpdateResponse",
"schema": [
{
"name": "traceId",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "Unique id for logging"
},
{
"name": "subscriptionId",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "Monoova generated Guid to uniquely identify the subscription.."
}
],
"modelRef": "#/components/schemas/SubscriptionUpdateResponse",
"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": "inUV9eCmRpFTcIITgKFu8",
"language": "curl",
"label": "cURL",
"code": "curl --request PUT \\\n --url https://sand-api.monoova.com/au/core/notification-v1/Subscription/{subscriptionId} \\\n --header 'accept: text/plain' \\\n --header 'content-type: application/json-patch+json' \\\n --data '{\n \"subscriptionName\": \"\",\n \"eventName\": \"\",\n \"webHookDetail\": {\n \"callBackUrl\": \"\"\n },\n \"isActive\": \"\"\n }'"
},
{
"id": "vnMshsD0bd039s0XRNny7",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"text/plain\");\nmyHeaders.append(\"content-type\", \"application/json-patch+json\");\n\nvar raw = JSON.stringify({\n \"subscriptionName\": \"\",\n \"eventName\": \"\",\n \"webHookDetail\": {\n \"callBackUrl\": \"\"\n },\n \"isActive\": \"\"\n});\n\nvar requestOptions = {\n method: 'PUT',\n headers: myHeaders,\n body: raw,\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": "uLBuVDonJ8425vyz8x_4f",
"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::Put.new(url)\nrequest[\"accept\"] = \"text/plain\"\nrequest[\"content-type\"] = \"application/json-patch+json\"\nrequest.body = JSON.dump({\n \"subscriptionName\": \"\",\n \"eventName\": \"\",\n \"webHookDetail\": {\n \"callBackUrl\": \"\"\n },\n \"isActive\": \"\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n"
},
{
"id": "mdweiu-nX3V86GsCPflhZ",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://sand-api.monoova.com/au/core/notification-v1/Subscription/{subscriptionId}\"\n\npayload = json.dumps({\n \"subscriptionName\": \"\",\n \"eventName\": \"\",\n \"webHookDetail\": {\n \"callBackUrl\": \"\"\n },\n \"isActive\": \"\"\n})\nheaders = {\n 'accept': 'text/plain',\n 'content-type': 'application/json-patch+json'\n}\n\nresponse = requests.request(\"PUT\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "inUV9eCmRpFTcIITgKFu8"
},
"results": {
"languages": [
{
"id": "2HCg6vXhh3qwtSNDabq9G",
"language": "200",
"code": "// OK\n{\n \"traceId\": \"\",\n \"subscriptionId\": \"\"\n}"
},
{
"id": "kGJ6z0c_HZuhNmnsBzB7f",
"language": "400",
"code": "// Bad Request\n{\n \"traceId\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n }\n ]\n}"
},
{
"id": "19kGyjhu0oW2NS1RRsPoE",
"language": "401",
"code": "// Unauthorized\n{\n \"traceId\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n }\n ]\n}"
},
{
"id": "oNQyB5UyeOWnWkmKiNVLK",
"language": "403",
"code": "// Forbidden\n{\n \"traceId\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n }\n ]\n}"
},
{
"id": "MlQ5XwV9zSmYGt3FDvEbO",
"language": "404",
"code": "// Not Found\n{\n \"traceId\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n }\n ]\n}"
},
{
"id": "UpSAnW4byVKgD-6tyqV_a",
"language": "500",
"code": "// Internal Server Error\n"
}
],
"selectedLanguageId": "2HCg6vXhh3qwtSNDabq9G"
}
},
"children": [
{
"text": ""
}
]
}