Yms apiCarrier level 1
POST Delete Carrier
POST Delete Carrier
Introduction
Deletes a carrier from the system. This operation should be used with caution as it permanently removes the carrier record. Typically used for removing duplicate entries or carriers that are no longer in service. The system may prevent deletion if the carrier is referenced in active appointments or historical records.
API Request
POST /public/carrier/{carrierId}/delete
Request Parameters
Name | Location | Type | Required | Description |
|---|---|---|---|---|
carrierId | path | string | Yes | none |
X-Tenant-ID | header | string | No | none |
X-Yard-ID | header | string | No | none |
Item-Time-Zone | header | string | No | none |
Authorization | header | string | No | none |
Response Example
200 Response
Response
Status Code | Definition | Description | Data Model |
|---|---|---|---|
200 | OK | none | RVoid |