Skip to main content
PATCH
Update a pickup location

Authorizations

Authorization
string
header
required

A business-bound HaulStow API key. Send Authorization: Bearer hsg_live_key_... to the live server or a hsg_test_key_... key to the sandbox server. Never expose this key in a browser.

Headers

X-Request-ID
string

Optional caller correlation ID. Use 1–128 ASCII letters, digits, ., _, -, or :. Invalid values are replaced. The accepted/generated value is returned in the response.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9._:-]+$
Idempotency-Key
string

Optional for naturally idempotent cancellation; recommended for a uniform mutation policy.

Required string length: 8 - 255

Path Parameters

pickup_location_id
string
required
Pattern: ^pkp_[a-f0-9]{32}$
Example:

"pkp_9b2f0c1e4d5a4b6c8e7f1a2b3c4d5e6f"

Body

application/json
name
string
Required string length: 1 - 255
contact
string
Required string length: 5 - 64
address
string
Required string length: 1 - 500
latitude
number<double>
longitude
number<double>
active
boolean

Response

Pickup location updated.

success
boolean
required
statusCode
enum<integer>
required
Available options:
200,
201
message
string
required
data
object
required