POST api/Account/Address

Sets an account's address. The update will fail if an attempt to set the countryCode to a value other than the one the account is set to is made. You must change the account country first. Once a campaign subscription has been created the account's country cannot be changed via the API.

Note on Address Info: The address info for the account is not requested by SiteWit for marketing purposes or to contact the client directly, but rather is needed by some Search Marketing Providers to determine acceptable advertising policies and settlement currency. It is therefore vital to have accurate information in order to assure the availability of settling the account in the appropriate currency.

Request Information

Authentication Method

Partner/Account Authentication

URI Parameters

None.

Body Parameters

Address (Create)
NameDescriptionTypeAdditional 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

HttpStatusCode

Response Formats

application/json, text/json

Sample:
"OK"

application/xml, text/xml

Sample:
<HttpStatusCode xmlns="http://schemas.datacontract.org/2004/07/System.Net">OK</HttpStatusCode>