Create an Address
2min
POST
AUTHENTICATION
Authorization
string
Bearer
BODY PARAMETERS
body
object
address
string
*Street number and name.
Commonly referred to as `address1`
unit
string
Any Apt/Unit/etc.
Commonly referred to as `address2`
postal_code
string
*Valid Postal Code
city
string
*City
country_code
string
Valid 2 Digit Country Code ("US" by default). Here is a list of valid codes: https://www.iban.com/country-codes
address_name
string
Address Name
notes
object
parking
object
RESPONSES
201
Created
Address
# About Addresses
These are the physical locations where you are looking schedule Jobs. There are 3 kinds of information generally in the addresses section:
1) Details on where the property is (address, postal_code, country code, or city).
2) Notes on how to get into the property and close up after the service.
3) Parking information such as where to park, or how to seek reimbursement for paid parking (if relevant).
# Managing Addresses
A Customer can have many Addresses. An Address can have 1 or many scheduled Jobs at a time. Adding an Address allows you to schedule a Job on that Address.
> **Note:** You cannot edit the `address`, `unit`, `city`, `postal_code`, or `country_code`. You must add a new Address.
# More details about an Address
| Attribute | Description |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| address | Street number and name. Commonly referred to as `address1`
| unit | Any Apt/Unit/etc. Commonly referred to as `address2`
| city | City name
| postal_code | Valid Postal Code
| country_code | Valid Country Code. It's **US** by default
| address_name | Address Name
| notes.access | Notes for accessing the property where the service is to be provided.
| notes.closing | Notes for closing the property after service
| parking.paid_parking | Does parking require an upfront payment? True or False
| parking.parking_spot | Describe the parking spot for the Provider.
**myspot** - Use Client's parking spot or driveway
**guest** - Guest parking
**meter** - Meter parking only. Reimbursement expected
**street** - Street parking
**paidlot** - Parking lot that requires payment | | parking.parking_pay_with | How is the Client going to cover parking reimbursement, card or cash?
**card** - Will charge reimbursements to the card on file (this is the default)
**cash** - Give Cash in-person to the Provider | parking.max_parking_cost | If paying with card, what is the maximum amount the Provider can get automatic approval? Reimbursements over this amount will require manual verification of reimbursement | parking.parking_notes | Notes about parking. Ex. Street sweeping days that impact parking or parking permits required. | created_at | Date and time of when the `Address` was created. UTC and ISO formatted |
**myspot** - Use Client's parking spot or driveway
**guest** - Guest parking
**meter** - Meter parking only. Reimbursement expected
**street** - Street parking
**paidlot** - Parking lot that requires payment | | parking.parking_pay_with | How is the Client going to cover parking reimbursement, card or cash?
**card** - Will charge reimbursements to the card on file (this is the default)
**cash** - Give Cash in-person to the Provider | parking.max_parking_cost | If paying with card, what is the maximum amount the Provider can get automatic approval? Reimbursements over this amount will require manual verification of reimbursement | parking.parking_notes | Notes about parking. Ex. Street sweeping days that impact parking or parking permits required. | created_at | Date and time of when the `Address` was created. UTC and ISO formatted |
object
string
*Type of object being returned
id
integer
*address
string
*Street number and name.
Commonly referred to as `address1`
unit
string
*Any Apt/Unit/etc.
Commonly referred to as `address2`
city
string
*City name
postal_code
string
*Valid Postal Code
country_code
string
*Valid 2 Digit Country Code ("US" by default). Here is a list of valid codes: https://www.iban.com/country-codes
address_name
string
*Address name
notes
object
*parking
object
*created_at
string
*Date and time of when the `Address` was created. UTC and ISO formatted
Updated 26 Apr 2023
Did this page help you?
Yes
No