Deletes the Multipass flow definition for the specified flow ID. This operation cannot be undone.
Request
Path parameters
| Key | Required | Type | Description |
|---|---|---|---|
| flowId | Yes | string |
Unique identifier for the Multipass flow |
Header keys
| Key | Required | Type | Description |
|---|---|---|---|
| X-Request-Id | No | String |
An optional header that allows clients to supply a
unique identifier for the request. When provided,
this value is recorded by the system and can be
used to trace and diagnose issues more
efficiently. Supplying an
|
Response
When a Multipass flow definition is deleted using a valid flow ID, the response confirms the deletion outcome. Because deletion is irreversible, the response focuses on acknowledging success or providing error details.
Response body properties
| Property | Type | Description |
|---|---|---|
| status | string |
Represents the outcome of the operation. Common
values include |
| flowId | string | The unique identifier of the Multipass flow associated with the request or response. This value corresponds to the flow being deleted. |
Response examples
Example status code responses for this method are shown here.
{
"status": "SUCCESS",
"flowId": "deleted_flow_id"
}{
"id": "0049c2dbb58b8393e8bced346fd8d660",
"errors": [
{
"code": "DIS-1001",
"detail": "Unauthorized"
}
]
}
"id": "b17e82b13b6b7d88eaf886636fae8b4d",
"errors": [
{
"code": "DIS-1002",
"detail": "You do not have permission to access this API"
}
]
}
"id": "f287c3b95d11f9ff28472ccc9ff38929",
"errors": [
{
"code": "DIS-1005",
"detail": "Rate limit exceeded"
}
]
}{
"id": "6900b63d72d75452c6c982afef49dc70",
"errors": [
{
"code": "DIS-MP-1002",
"detail": "Invalid Flow Id. Flow ID cannot be null or empty."
}
]
}{
"id": "f287c3b95d11f9ff28472ccc9ff38929",
"errors": [
{
"code": "DIS-1003",
"detail": "Issue with internal services. Please try again after sometime"
}
]
}