api/v1/customers/{id}/Update
Method: PATCH https://developers.mobilemanager.co.uk/api/v1/customers/{id}/Update
Summary
Updates a customer
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | globally unique identifier |
Required |
Body Parameters
The properties required to update the customer
CustomerPatchModelName | Description | Type | Additional information |
---|---|---|---|
Name | string |
None. |
|
CustomerDefaultEmail | string |
None. |
|
DefaultPoolId | globally unique identifier |
None. |
|
Suspended | boolean |
None. |
|
Hidden | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "Name": "sample string 1", "CustomerDefaultEmail": "sample string 2", "DefaultPoolId": "33edca4f-4b0b-4516-b480-14274db22ab5", "Suspended": true, "Hidden": true }
application/xml, text/xml
Sample:
<CustomerPatchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SimPortalApi.Controllers"> <CustomerDefaultEmail>sample string 2</CustomerDefaultEmail> <DefaultPoolId>33edca4f-4b0b-4516-b480-14274db22ab5</DefaultPoolId> <Hidden>true</Hidden> <Name>sample string 1</Name> <Suspended>true</Suspended> </CustomerPatchModel>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
CustomerPatchModelName | Description | Type | Additional information |
---|---|---|---|
Name | string |
None. |
|
CustomerDefaultEmail | string |
None. |
|
DefaultPoolId | globally unique identifier |
None. |
|
Suspended | boolean |
None. |
|
Hidden | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "Name": "sample string 1", "CustomerDefaultEmail": "sample string 2", "DefaultPoolId": "9f501046-b0b4-4177-ab0f-85ad4bc7ddee", "Suspended": true, "Hidden": true }
application/xml, text/xml
Sample:
<CustomerPatchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SimPortalApi.Controllers"> <CustomerDefaultEmail>sample string 2</CustomerDefaultEmail> <DefaultPoolId>9f501046-b0b4-4177-ab0f-85ad4bc7ddee</DefaultPoolId> <Hidden>true</Hidden> <Name>sample string 1</Name> <Suspended>true</Suspended> </CustomerPatchModel>