Skip to main content
POST
Create an ETA session

Authorizations

API-Key
string
header
required

Your API key, from More → API & Integrations in the dashboard, or from ht signup / ht auth login.

Body

application/json
jobId
string
required
recipientName
string

Defaults to the job's contact name.

recipientPhone
string

Defaults to the job's contact phone.

recipientEmail
string

Defaults to the job's contact email.

title
string

Defaults to the job title, or 'Service visit'.

showWorkerName
boolean

Defaults to the company setting etaPageDefaultShowWorkerName.

showMap
boolean

Defaults to the company setting etaPageDefaultShowMap.

expiresIn

How long the link lives: milliseconds, or a number with m, h or d (30m, 24h, 30d). Default 30 days, at most 90 days. 'expires' wins over 'expiresIn'.

expires

Same as expiresIn.

Response

Success

data
object
required
error
null
required
meta
object
required