Update CustomerAddress by ID

patch

https://qa2.revelup.com/resources/CustomerAddress/{CustomerAddressId}/

Updates a single CustomerAddress object

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

CustomerAddressId

int64

required

ID of CustomerAddress to update

Body Params

CustomerAddress data that needs to be changed

active

boolean

Defaults to true

Flag. If set to True, the address is visible and can be used for delivery.

address_type

integer

deprecated

Deprecated field - see "primary_billing" and "primary_shipping" instead.

city

string

length ≤ 100

Field used to specify the customer's city.

company_name

string

Field used to specify the name of the customer's associated company.

country

string

required

length ≤ 2

Field used to specify the customer's country. Expects a ISO 3166-2 country code.

created_date

date-time

ISO8601 timestamp of the time the resource was created.

delivery_instructions

string

Text field for additional information about this CustomerAddress.

string

Field used to specify the contact e-mail for this address.

name

string

length ≤ 60

Name of this delivery address.

phone_number

string

length ≤ 20

Field used to specify the contact number for this address.

primary_billing

boolean

Defaults to false

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

primary_shipping

boolean

Defaults to false

Flag. If set to True, this address will be used by default for all shipping/delivery orders.

state

string

length ≤ 50

Field used to specify the customer's state.

street_1

string

length ≤ 280

Field used to specify the first line of the customer'saddress.

street_2

string

length ≤ 280

Field used to specify the second line of the customer'saddress. Not validated - can contain additional address info such as door number,floor, etc.

updated_date

date-time

ISO8601 timestamp of the time the resource was updated.

uuid

UUID of this Package resource.

zipcode

string

length ≤ 20

Field used to specify the customer's postal code.

Responses

301

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

400

Invalid input - please run the request body through a JSON validator.

401

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

404

CustomerAddress not found

445

Message: Integrity Error - an invalid value was provided for one of the fields.

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Resource successfully created.