v1

latestOpenAPI 3.1.02026-07-243113441.2 MB

Contractors

Create or update a contractor's address

The address of a contractor is used to determine certain tax information about them. Addresses are geocoded on create and update to ensure validity.

🚧 Contractors can only have one address.

When a contractor is created, an address is created for them by default. Updating the address will replace the existing address.

scope: contractors:write

put/v1/contractors/{contractor_uuid}/address

Path parameters

contractor_uuidstring required

The UUID of the contractor

Headers

X-Gusto-API-Version'2026-06-15'

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Request body

versionstring required

The current version of the object. See the versioning guide for information on how to use this field.

street_1string

street_2string

citystring

statestring

zipstring

Example request

{
  "version": "56d00c178bc7393b2a206ed6a86afcb4"
}

Response

Successful

contractor_uuidstring

The UUID of the contractor

street_1string nullable

street_2string nullable

citystring nullable

statestring nullable

zipstring nullable

countrystring nullable

activeboolean

The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.

versionstring

The current version of the object. See the versioning guide for information on how to use this field.