Skip to main content
POST
Add or reuse a recipient address

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
required

A unique key for this logical mutation. Retained for 24 hours.

Required string length: 8 - 255

Path Parameters

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

"rcp_3f1a821cdb58498cbb52f4706545a089"

Body

application/json
address
string
required
Required string length: 2 - 500
latitude
number<double>
required
Required range: -90 <= x <= 90
longitude
number<double>
required
Required range: -180 <= x <= 180
label
string
Maximum string length: 64
municipality
string
Maximum string length: 128
delivery_notes
string
Maximum string length: 500

Response

Existing address returned.

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