Create Address

post

https://wh.route4me.com/modules/api/v5.0/address-book/addresses

Add a new Address Book Contact by sending a body payload with the corresponding parameters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

address_1

string

required

address_2

string

address_zip

string

address_group

string

address_alias

string

address_city

string

address_state_id

string

address_country_id

string

first_name

string

last_name

string

address_email

string

address_phone_number

string

cached_lat

number

required

cached_lng

number

required

curbside_lat

number

curbside_lng

number

address_custom_data

object

local_time_window_start

number

local_time_window_end

number

local_time_window_start_2

number

local_time_window_end_2

number

local_timezone_string

string

service_time

number

0 to 65535

color

string

address_icon

string

schedule

array of objects

schedule

schedule_blacklist

array of strings

Also can be a date string with the 'YYYY-MM-DD' format.

schedule_blacklist

address_stop_type

string

enum

Allowed:

address_cube

number

address_pieces

number

address_reference_no

string

address_revenue

number

address_weight

number

address_priority

number

address_customer_po

string

eligible_pickup

boolean

eligible_depot

boolean

is_validated

boolean

customer_id

string | null

parent_location_id

integer | null

200Successful operation.

403The user has read-only access.

406Validation Exception.