PUT api/customer/closereopen
Close or Reopen the active or closed customer respectively.
Requires Authorisation
The api request must supply authenticated token in a custom variable in the request header. The custom variable name is configured in web.config. The default name of the custom variable is “X-Fern-Token”.
Requires Api License and User Access
The api requires license and user permission for API ID, PUTapi/customer/closereopen. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.
Request Information
URI Parameters
None.
Body Parameters
Represents parameters to close/reopen the customer.
CustomerCloseReopenDto| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomerID |
Customer's Id. |
integer | |
| Closed |
Customer is closed or not. |
boolean | |
| ClosedReasonID |
Customer closed reason Id. |
integer |
Request Formats
application/json, text/json
Sample:
{
"customerID": 1,
"closed": true,
"closedReasonID": 1
}
application/xml, text/xml
Sample:
<CustomerCloseReopenDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto"> <Closed>true</Closed> <ClosedReasonID>1</ClosedReasonID> <CustomerID>1</CustomerID> </CustomerCloseReopenDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Response Codes
Success Status:
- NoContent (204), the response does not have any content.
Failed Status(es):
Resource Description
No Content Status.
None.