Manage port contract cancellation
Schedule a port contract cancellation or remove a scheduled port contract cancellation.
Schedule port contract cancellation
Schedule a port contract cancellation.
Request
| Endpoint: | /api/ports/<port_id>/cancel |
| Method: | POST |
| Headers: | Accept: application/vnd.cloudlx.v1+json |
| Authorization: Bearer <access_token> |
Example Request:
{
"cancellation_date": "2024-05-16"
}
Request Values
| cancellation_date | Description | The date on which you wish the contract to cancel. |
| Type | Date | |
| Example | 2024-05-16 |
Response
Example:
{
"success": true,
"message": "Port updated successfully",
"warnings": [
"Port is within the minimum contract term. Additional penalty charges apply."
],
}
Response Values
| warnings | Description | An array of strings indicating potential warnings about the selected date. An empty array means there are no warnings. |
| Type | Array[String] | |
| Example | [ "Port is within the minimum contract term. Additional penalty charges apply." ] |
Remove scheduled port contract cancellation
Remove a scheduled a port contract cancellation.
Request
| Endpoint: | /api/ports/<port_id>/cancel |
| Method: | POST |
| Headers: | Accept: application/vnd.cloudlx.v1+json |
| Authorization: Bearer <access_token> |
Example Request:
{
"cancellation_date": null
}
Request Values
| cancellation_date | Description | The date on which you wish the contract to cancel. |
| Type | Null | |
| Example | null |
Response
Example:
{
"success": true,
"message": "Port updated successfully"
}