Update address

put

https://www.pelcro.com/api/v1/sdk/address/{address_id}

Update an existing customer address.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Overview

Update an existing address belonging to the authenticated customer. Returns the updated customer plus a meta block. The address type cannot be changed. Requires a bearer token.

Example: A customer corrects the city and postal code on their shipping address.

📘
Authentication required
Send a bearer token as Authorization: Bearer <token>. An address the customer does not own returns 404 Address not found.

Conditional Requirements

Condition	Required Fields
Always	`type`, `first_name`, `last_name`, `city`, `state`, `postal_code`

Path Params

address_id

int32

required

The unique identifier of the address.

Query Params

site_id

int32

required

The unique identifier of the site associated with your account.

Body Params

type

string

required

The address type, one of either "shipping" or "billing". Always required.

country

string

length ≤ 2

The two-letter code of the country, as specified by ISO 3166 alpha-2 standard. Always required.

line1

string

length ≤ 255

The first line of the address. Always required.

first_name

string

required

length ≤ 255

The address's first name that belongs to the customer. Always required.

last_name

string

required

length ≤ 255

The address's last name that belongs to the customer. Always required.

city

string

required

length ≤ 255

The name of a city, town, village, etc. Always required.

state

string

required

length ≤ 255

The two-letter code of the state, region, or province. Always required.

postal_code

string

required

length ≤ 45

Postal code or zip associated with the address. Always required.

language

string

enum

length ≤ 2

Defaults to en

The customer’s preferred language as a two-letter code, defined by ISO 639-1 standard. If not specified, it will be set from Accept-Language header, or from the default language defined in your site settings as a fallback.

Allowed:

line2

string

length ≤ 255

The second line of the address.

is_default

boolean

Set this address as the new default. Only one default address of the same type can be set at all times.

phone

string

length between 5 and 20

Numeric phone number associated with the address.

company

string | null

Company name for the address.

title

string | null

Title for the address.

department

string | null

Department for the address.

delivery_instructions

string | null

Delivery instructions for the address (max 500 characters).

delivery_sequence_number

integer | null

≥ 1

Delivery sequence number for the address.

Responses

Overview

Authentication required

Conditional Requirements

200Success.

400Invalid request.

401Unauthorized.

404Not found.