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

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters

The properties required to update the customer

CustomerPatchModel
NameDescriptionTypeAdditional 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": "44434d52-085a-46c4-a9f2-c02396e2919f",
  "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>44434d52-085a-46c4-a9f2-c02396e2919f</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
NameDescriptionTypeAdditional 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": "2ea0feee-a0fe-41c2-bbbd-e4f1dc687525",
  "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>2ea0feee-a0fe-41c2-bbbd-e4f1dc687525</DefaultPoolId>
  <Hidden>true</Hidden>
  <Name>sample string 1</Name>
  <Suspended>true</Suspended>
</CustomerPatchModel>