Preferred Start Options

The Preferred Start Options feature allows customers to indicate when they would like work to begin. This helps tradespeople better understand the customer's timeline and prioritise accordingly.

Overview

When creating a job, you can optionally include a preferredStart object that specifies:

• The customer's preferred timing for starting the work

This information is passed to tradespeople receiving the job, helping them understand the customer's urgency and scheduling needs.

Endpoints

There are two environments, each using a different API Keys.

Available Options

To get the current list of available preferred start options, use the GET {baseUrl}/preferred-start-options endpoint.

GET /preferred-start-options

Authentication: Required (see HTTP Signature Scheme)

Request: No request body needed

Response: Array of preferred start option objects

Example Response:

[
  {
    "id": "FLEXIBLE",
    "label": "I'm flexible on start date"
  },
  {
    "id": "URGENT",
    "label": "It's urgent (within 48 hours)"
  },
  {
    "id": "WITHIN_2_WEEKS",
    "label": "Within 2 weeks"
  },
  {
    "id": "WITHIN_1_MONTH",
    "label": "Within 1 month"
  },
  {
    "id": "PLANNING_AND_BUDGETING",
    "label": "I'm planning and budgeting"
  }
]