PATCH

apiportal/v1/community/{ID}/address

Updates an existing address. Replaces only fields specified in the request.

Request Information

Roles

Vendor_APIClient

URI Parameters

Name	Description	Type	Additional information
ID	Community member ID	integer	Required

Body Parameters

Address update details

spuCommunityAddress

Name	Type	Additional information
HomeAddress1	string	None.
HomeAddress2	string	None.
HomeAddress3	string	None.
HomeSuburb	string	None.
HomeState	string	None.
HomePostCode	string	None.
HomeCountryCode	string	None.
Address1	string	None.
Address2	string	None.
Address3	string	None.
Suburb	string	None.
State	string	None.
PostCode	string	None.
CountryCode	string	None.
PhoneActual	string	None.
PhoneAlt	string	None.
SilentPhoneFlag	boolean	None.
Fax	string	None.
HomeAddressSameFlag	boolean	None.

Request Formats

{
  "HomeAddress1": "sample string 1",
  "HomeAddress2": "sample string 2",
  "HomeAddress3": "sample string 3",
  "HomeSuburb": "sample string 4",
  "HomeState": "sample string 5",
  "HomePostCode": "sample string 6",
  "HomeCountryCode": "sample string 7",
  "Address1": "sample string 8",
  "Address2": "sample string 9",
  "Address3": "sample string 10",
  "Suburb": "sample string 11",
  "State": "sample string 12",
  "PostCode": "sample string 13",
  "CountryCode": "sample string 14",
  "PhoneActual": "sample string 15",
  "PhoneAlt": "sample string 16",
  "SilentPhoneFlag": true,
  "Fax": "sample string 18",
  "HomeAddressSameFlag": true
}

<spuCommunityAddress xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.APIClient">
  <Address1>sample string 8</Address1>
  <Address2>sample string 9</Address2>
  <Address3>sample string 10</Address3>
  <CountryCode>sample string 14</CountryCode>
  <Fax>sample string 18</Fax>
  <HomeAddress1>sample string 1</HomeAddress1>
  <HomeAddress2>sample string 2</HomeAddress2>
  <HomeAddress3>sample string 3</HomeAddress3>
  <HomeAddressSameFlag>true</HomeAddressSameFlag>
  <HomeCountryCode>sample string 7</HomeCountryCode>
  <HomePostCode>sample string 6</HomePostCode>
  <HomeState>sample string 5</HomeState>
  <HomeSuburb>sample string 4</HomeSuburb>
  <PhoneActual>sample string 15</PhoneActual>
  <PhoneAlt>sample string 16</PhoneAlt>
  <PostCode>sample string 13</PostCode>
  <SilentPhoneFlag>true</SilentPhoneFlag>
  <State>sample string 12</State>
  <Suburb>sample string 11</Suburb>
</spuCommunityAddress>

Sample not available.

Response Information

Resource Description

ChangeEntitySeqModel

Name	Type	Additional information
EntitySeq	integer	None.
Error	string	None.
ValidationDetails	Collection of ValidationDetails	None.

{
  "EntitySeq": 1,
  "Error": "sample string 1",
  "ValidationDetails": [
    {
      "FieldName": "sample string 1",
      "Reason": "sample string 2"
    },
    {
      "FieldName": "sample string 1",
      "Reason": "sample string 2"
    }
  ]
}

<ChangeEntitySeqModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.APIClient">
  <Error>sample string 1</Error>
  <ValidationDetails>
    <ValidationDetails>
      <FieldName>sample string 1</FieldName>
      <Reason>sample string 2</Reason>
    </ValidationDetails>
    <ValidationDetails>
      <FieldName>sample string 1</FieldName>
      <Reason>sample string 2</Reason>
    </ValidationDetails>
  </ValidationDetails>
  <EntitySeq>1</EntitySeq>
</ChangeEntitySeqModel>