core

Create a hand-off: returns an id and a sign-up link carrying the partner tag, move date and new address. Read-only — no account is created until the person signs up.

When someone has just signed a lease, accepted an offer, or otherwise has a move coming: returns a PutRoots link that pre-fills their move date and new address and attributes them to you. Nothing is created on their behalf — they sign up themselves by opening the link. Use the returned id with GET /v1/handoffs/{id} to see which stage of the move they are in.

post/v1/handoffs

Request

  • Base URL: https://www.putroots.com
  • URL: https://www.putroots.com/v1/handoffs
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Request body

triggerstring required

What set the move off: lease_signed, offer_accepted, relocation_approved, or your own short label.

stage'pre_arrival' | 'housing' | 'move_planning' | 'move_logistics' | 'activate' | 'settle' | 'stabilize'

Which stage of the journey they are in right now, if you know it.

d0string

Move-in day, YYYY-MM-DD.

tostring

The new address, as one line.

profile_seedobject

Reserved. Accepted but not applied yet — the person fills their own profile after signing up.

Response

OK

sourceunknown required
fetched_atstring date-time required
idstring required
urlstring required
partnerstring required
triggerstring required
stagestring nullable
d0string nullable
tostring nullable
dry_runboolean required

true when called with a pr_test_ key.

Changes

No recorded changes to this operation across all 1 revision of this API.