api/v1/customers/{id}/Update

Method: PATCH https://simportal-api-staging.azurewebsites.net/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

CustomerPatchModel

Name	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": "76d5f94a-17d6-4158-87e0-ed087b6c6def",
  "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>76d5f94a-17d6-4158-87e0-ed087b6c6def</DefaultPoolId>
  <Hidden>true</Hidden>
  <Name>sample string 1</Name>
  <Suspended>true</Suspended>
</CustomerPatchModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CustomerPatchModel'.

Response Information

Resource Description

CustomerPatchModel

Name	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": "aad1546f-ebaf-4245-acec-b2daf7906d11",
  "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>aad1546f-ebaf-4245-acec-b2daf7906d11</DefaultPoolId>
  <Hidden>true</Hidden>
  <Name>sample string 1</Name>
  <Suspended>true</Suspended>
</CustomerPatchModel>