website logo
⌘K
Getting Started
What is TIDY?
Getting Started: Rental Properties
Getting Started: Employer Benefits
Getting Started: Residential Homes
Getting Started: Offices
Dashboard
TIDY AI
Acceptance Probability
Teams & Users
Users
Teams
Properties/Addresses
Access Instructions
Jobs
Add or Request a Job
View, Edit, or Cancel Jobs
Setting Backup Times
Job Links
Job Reviews or Feedback
Resolving Pro Cancellations
Account Settings
Messages
Notifications
Plans
Access Control / Smartlocks
My Pros
Booking Different Type Of Services With Your Pros
Private Cleaning Payment
Defining your Job Request Strategy
To-Do Lists
Video Introductions
To-Do List Links
To-Dos
Do-Nots
Remote Inspections
Custom Fields
Laundry or Linens
Supply Preferences
Integrations
Automatic Booking
Billing, Pricing, & Payments
Billing History
Sending Payments
Bills & Payment Methods
Team Billing
View & Edit Prices
Viewing Billing History
Tips
Refunds
Rebate Program
Tax Reporting for Payments to Pros
Compliance, Ratings, Safety, Insurance, & Protection
Insurance or Custom Requirements
Certifications & Ratings
Satisfaction Guarantee, Disputes, & Protection
Damage Claims
Property Maps
Maintenance
Inventory Tracking
Inspections
Smart Thermostats
Issue Tracking
Automatic Translation
Other Questions
TIDY Concierge
Reports
Accounting
Developers
API Introduction
Authentication
Changelog
Errors
API Reference
Webhooks
Best Practices
Docs powered by archbee 

Create an Address

2min
POST

To create an Address, send the street name and number as address (e.g. 123 Main St) along with the postal_code (e.g. 92626) and country code (e.g. US). It is optional to send any apartment or unit number as unit (e.g. Apt 7).

Parking

Parking details provide context for someone how to park their car. Required fields are:

  • If parking is paid or not (parking.paid_parking)
  • Where the Provider is meant to park (parking.parking_spot)
  • How much the Client will reimburse for parking (parking.parking_pay_with)
  • Any other notes about parking (parking.parking_notes) (e.g. "Park around back in my designated spot for Apt 7 labelled on the ground"). Good things to include here are street sweeping days or parking permits required.

Access and Closing Notes

You can also add notes for accessing the property (notes.access) (e.g. "Key is in the lockbox code 1234") and notes for closing the property after service (notes.closing) (e.g. "Make sure you put the key back into the lockbox, code 1234").

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 |
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
PREVIOUS
List all Addresses
NEXT
Delete an Address
Docs powered by archbee