4.2 Close Interested Party
Updated at: 3/27/2023 2:15:10 AM
Url
/api/v2/{fleet_token}/contractors/{contractor_id}/units/{unit_id}/interestedparties/close/{id}
Method
Post
Body
```json
{
"EffectiveDate": "<date:Date>"
}
```
Parameters
- `EffectiveDate`. Optional. You could leave the body blank if you like. The default value for effective date is **Today**.
Response
```json
{
"Success": "<true|false>",
"Message": "<message>",
"Data": {
"ID": "<INT>",
"Name": "<name>",
"Email": "<email>",
"PhoneNumber": "<phone_number>",
"Address": "<address>",
"Address2": "<address2>",
"City": "<city>",
"State": "<state>",
"Zip": "<zip>",
"Type": "<type>",
"InactivationDate": "<date:Date>"
}
}
```
Returns
The closed interested party will be returned in the response.
Notes
- The request would fail if the given interested party is already closed in CBA.
- The request would fail if it fails to locate the motor carrier by `fleet_token`.
In this article