GuidesDiscussionsAPI ReferenceChangelogMy Application
HomeGuidesAPI ReferenceChangelogDiscussions
GuidesDiscussionsAPI ReferenceChangelogMy ApplicationLog In
API Reference

Updates details of an Address object

patch
https://qa2.revelup.com/resources/Address//

Updates details of an Address object specified by ID

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

ID of Address to update

Body Params

Address data that needs to be changed

boolean
Defaults to false

Flag. If set to False, the address can not be used as an external shipping address.

string
length ≤ 80

Address alias. Used as a reference when choosing external shipping addresses.

string
length ≤ 12

Custom field used only in Fuel Retail mode.

string
required
length ≤ 100

City name, used in geolocation.

string
required
length ≤ 2

Address country code. Values are expected to follow the ISO 3166-2 standard.

string
length ≤ 120

Address county stored in an arbitrary format - can be a FIPS code or the full county name. Used only in Fuel Retail mode.

uri
required

URI of the User that created this resource.

date-time

ISO8601 timestamp of the time the resource was created.

string
length ≤ 120

Custom field used only in Fuel Retail mode.

string
length ≤ 12

Custom field used only in Fuel Retail mode.

boolean
Defaults to false

Flag. If set to True, this address will be used by default for all invoices.

float
-90 to 90

Exact geographic latitude of the address.

string
required
length ≤ 280

First line of the address. Used in geolocation, so it should be searchable by most map providers.

string
length ≤ 280

Second line of the address. Not used in geolocation, so any additional address info can go here.

float
-180 to 180

Exact geographic longitude of the address.

string
length ≤ 120

Address province stored in an arbitrary format.

string

Address state stored in a the FIPS state code format. Non-US addresses should use a "--" value.

date-time

ISO8601 timestamp of the time the resource was updated.

uri
required

URI of the User that last updated this resource.

uuid

Resource UUID. Must be unique for all resources.

string
required
length ≤ 10

Address postal code. Used in geolocation, so should match the standard of the address country.

Responses

301

Invalid request URL - make sure that the URL ends with a trailing slash.

400

Bad request. Usually caused by invalid request body.

401

Authentication error - make sure the API key & secret is valid, active and provided in the "API-AUTHENTICATION" header.

404

Address with the provided ID not found.

Updated over 2 years ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago