Terminal Shipping API
Ask or search…
K

Update Address

Update information for an existing address.
put
https://api.terminal.africa
/v1/addresses/:address_id
/addresses/:address_id
This endpoint allows you to update an existing address.
Parameters
Path
address_id*
String
Unique identifier for address
Header
Authorization*
String
Set value to Bearer SECRET_KEY
Content-Type
String
Set value to application/json
Body
city*
String
Address city.
country*
String
ISO 2 country code for address.
email
String
Email of person at address.
first_name
String
First name of person at address. Required for arranging pickup / delivery.
is_residential
Boolean
Indicates if address is a residential address or not. Defaults to true.
last_name
String
Last name of person at address. Required for arranging pickup / delivery.
line1
String
Street address. Required for arranging pickup / delivery.
line2
Second line of street address
metadata
Object
Additional information for an address.
name
String
Full name of person at address
phone
String
Phone number of person at address. Must match country provided in address. Required for arranging pickup / delivery.
state
String
Address state
zip
String
Zip / Postal code. Required for arranging pickup / delivery.
Responses
200: OK
Address updated successfully.