PATCH v1/admin/company/{id}/ProfileAddresses/{addressName}

Update Profile Company Address

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

addressName

string

Required

Body Parameters

CompanyPatchAddressInput
NameDescriptionTypeAdditional information
line1

string

None.

line2

string

None.

city

string

None.

stateProvince

string

None.

postalCode

string

None.

country

string

None.

Request Formats

application/json, text/json

Sample:
{
  "line1": "sample string 1",
  "line2": "sample string 2",
  "city": "sample string 3",
  "stateProvince": "sample string 4",
  "postalCode": "sample string 5",
  "country": "sample string 6"
}

text/html

Sample:
{"line1":"sample string 1","line2":"sample string 2","city":"sample string 3","stateProvince":"sample string 4","postalCode":"sample string 5","country":"sample string 6"}

application/xml, text/xml

Sample:
<v1_Admin_CompanyEndpointController.CompanyPatchAddressInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_Admin_CompanyEndpoint">
  <city>sample string 3</city>
  <country>sample string 6</country>
  <line1>sample string 1</line1>
  <line2>sample string 2</line2>
  <postalCode>sample string 5</postalCode>
  <stateProvince>sample string 4</stateProvince>
</v1_Admin_CompanyEndpointController.CompanyPatchAddressInput>

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 'CompanyPatchAddressInput'.

Response Information

Resource Description

CompanyProfileAddress
NameDescriptionTypeAdditional information
id

The id of this address

integer

None.

name

The name of this address

string

None.

line1

The addressLine1 of this address

string

None.

line2

The addressLine2 of this address

string

None.

city

The city of this address

string

None.

stateProvince

The state province of this address

string

None.

postalCode

The postal code of this address

string

None.

country

The country of this address

string

None.

isPreferredBillingAddress

The value indicate if profile address is preferred billing address

boolean

None.

isPreferredShippingAddress

The value indicate if profile address is preferred shipping address

boolean

None.

isPreferredMailingAddress

The value indicate if profile address is preferred mailing address

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "name": "sample string 2",
  "line1": "sample string 3",
  "line2": "sample string 4",
  "city": "sample string 5",
  "stateProvince": "sample string 6",
  "postalCode": "sample string 7",
  "country": "sample string 8",
  "isPreferredBillingAddress": true,
  "isPreferredShippingAddress": true,
  "isPreferredMailingAddress": true
}

text/html

Sample:
{"id":1,"name":"sample string 2","line1":"sample string 3","line2":"sample string 4","city":"sample string 5","stateProvince":"sample string 6","postalCode":"sample string 7","country":"sample string 8","isPreferredBillingAddress":true,"isPreferredShippingAddress":true,"isPreferredMailingAddress":true}

application/xml, text/xml

Sample:
<v1_Admin_CompanyEndpointController.CompanyProfileAddress xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_Admin_CompanyEndpoint">
  <city>sample string 5</city>
  <country>sample string 8</country>
  <id>1</id>
  <isPreferredBillingAddress>true</isPreferredBillingAddress>
  <isPreferredMailingAddress>true</isPreferredMailingAddress>
  <isPreferredShippingAddress>true</isPreferredShippingAddress>
  <line1>sample string 3</line1>
  <line2>sample string 4</line2>
  <name>sample string 2</name>
  <postalCode>sample string 7</postalCode>
  <stateProvince>sample string 6</stateProvince>
</v1_Admin_CompanyEndpointController.CompanyProfileAddress>