PUT api/partner/address

Updates the address on file for the given partner. Any data not passed will be understood as a desire to remove the existing data in that property.

Request Information

Authentication Method

Sub Partner Authentication

URI Parameters

None.

Body Parameters

Address (Create)

Name	Description	Type	Additional information
street1	Main street address	string	Required String length: inclusive between 2 and 250
street2	Additional address info (e.g. Apt, Ste., etc...)	string	String length: inclusive between 0 and 250
city	City name	string	Required String length: inclusive between 2 and 250
stateProv	State or Province is applicable	string	String length: inclusive between 2 and 3
countryCode	Country code for the address. This has implications on settlement currency.	string	Required A valid Country Code
postalCode	Postal/Zip code if applicable	string	String length: inclusive between 3 and 10

Request Formats

application/json, text/json

Sample:

{
  "street1": "123 Baxter Ct.",
  "street2": "Apt. 100",
  "city": "Coolsville",
  "stateProv": "FL",
  "countryCode": "US",
  "postalCode": "55555-5555"
}

application/xml, text/xml

Sample:

<Address xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.CreateModels">
  <city>Coolsville</city>
  <countryCode>US</countryCode>
  <postalCode>55555-5555</postalCode>
  <stateProv>FL</stateProv>
  <street1>123 Baxter Ct.</street1>
  <street2>Apt. 100</street2>
</Address>

Response Information

Successful Response:

Resource Description

Address

Name	Description	Type	Additional information
street1		string
street2		string
city		string
stateProv		string
postalCode		string
countryCode		string

Response Formats

application/json, text/json

Sample:

{
  "street1": "123 Baxter Ct.",
  "street2": "Apt. 100",
  "city": "Coolsville",
  "stateProv": "FL",
  "postalCode": "55555-5555",
  "countryCode": "US"
}

application/xml, text/xml

Sample:

<Address xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.ReturnModels">
  <city>Coolsville</city>
  <countryCode>US</countryCode>
  <postalCode>55555-5555</postalCode>
  <stateProv>FL</stateProv>
  <street1>123 Baxter Ct.</street1>
  <street2>Apt. 100</street2>
</Address>