PATCH api/company/{id}
This method updates selected details of specified company
Error messages
- 409/Conflict - Consumer must be a customer - isCustomer must be set to 'true'
- 409/Conflict - This Company is set to be a Reseller - A company cannot be a reseller and consumer
- 401/Unauthorised - Company permissions not valid - user does not have the required permissions
- 409/Conflict - This Company cannot be both a reseller and white label reseller - Ensure White label Reseller is set to false if Reseller is set to true
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | The company ID | integer |
Required |
Body Parameters
CompanyModify| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | The name of the company | string |
String length: inclusive between 0 and 50 |
| IsCustomer | Specify whether the company is a customer | boolean |
None. |
| IsAgent | Specify whether the company is an Agent | boolean |
None. |
| IsCarrier | Specify whether the company is a Carrier | boolean |
None. |
| IsReseller | Specify whether the company is a Reseller | boolean |
None. |
| IsSupplier | Specify whether the company is a Supplier | boolean |
None. |
| IsOperator | Specify whether the company is a Operator | boolean |
None. |
| IsProspect | Specify whether the company is a Prospect | boolean |
None. |
| DateSigned | Date the customer was signed up | date |
None. |
| DateReceived | Date the customer's sign up information was entered into the system | date |
None. |
| DateLive | Date the customer is live | date |
None. |
| LastContacted | Date the customer is last contacted | date |
None. |
| IsConsumer | Indicates whether the company is a consumer | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"IsWhiteLabelReseller": true,
"Name": "sample string 2",
"IsCustomer": true,
"IsAgent": true,
"IsCarrier": true,
"IsReseller": true,
"IsSupplier": true,
"IsOperator": true,
"IsProspect": true,
"DateSigned": "2025-04-25T14:02:40.136",
"DateReceived": "2025-04-25T14:02:40.136",
"DateLive": "2025-04-25T14:02:40.136",
"LastContacted": "2025-04-25T14:02:40.136",
"IsConsumer": true
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.