Skip to main content
PATCH
/
service-requests
/
{id}
/
lead-source
Update service request lead source
curl --request PATCH \
  --url https://ai-api.getbreezyapp.com/api/v1/service-requests/{id}/lead-source \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "leadSourceId": "<string>"
}
'
{
  "id": "<string>",
  "referenceNumber": "<string>",
  "conversationId": "<string>",
  "voiceCallId": "<string>",
  "contactId": "<string>",
  "excludedFromReporting": true,
  "manuallyExcludedFromReporting": true,
  "instantBooking": true,
  "customerName": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "phoneNumber": "<string>",
  "serviceAddress": "<string>",
  "serviceAddressLine1": "<string>",
  "serviceAddressLine2": "<string>",
  "serviceCity": "<string>",
  "serviceState": "<string>",
  "serviceZipCode": "<string>",
  "jobTypeId": "<string>",
  "jobTypeName": "<string>",
  "jobClassName": "<string>",
  "onlineBookingFormId": "<string>",
  "bookingFormSubmissionId": "<string>",
  "jobTypeFreetext": "<string>",
  "availabilityWindows": [
    {
      "raw": "<string>",
      "date": "<string>",
      "timeWindowStart": "<string>",
      "timeWindowEnd": "<string>",
      "timeWindowLabel": "<string>",
      "start": "<string>",
      "end": "<string>",
      "flexible": true
    }
  ],
  "serviceNeeded": "<string>",
  "emailAddress": "<string>",
  "preferredTimeWindow": "<string>",
  "isExistingCustomer": true,
  "leadSourceId": "<string>",
  "leadSourceName": "<string>",
  "conversationSummary": "<string>",
  "customFields": {},
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "fsmJobLeadGuid": "<string>",
  "fsmRecord": {
    "kind": "<unknown>",
    "jobLeadGuid": "<string>",
    "accountGuid": null,
    "locationGuid": null,
    "jobGuid": null,
    "appointmentGuid": null
  },
  "bookingDetails": {
    "confirmedWindowStart": "<string>",
    "confirmedWindowEnd": "<string>",
    "jobDurationMinutes": 0,
    "bookingRequestId": "<string>",
    "fsmCustomerGuid": "<string>",
    "fsmLocationGuid": "<string>",
    "fsmJobGuid": "<string>",
    "fsmAppointmentGuid": "<string>",
    "bookedAt": "<string>",
    "providerMetadata": {}
  }
}

Authorizations

Authorization
string
header
required

Auth0 user JWT bearer token. User principals can manage API keys and call tenant-scoped customer endpoints.

Path Parameters

id
string
required

Unique identifier (UUID)

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

Body

application/json
leadSourceId
string | null
required

Unique identifier (UUID)

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

Response

200 - application/json

OK

id
string
required

Unique identifier (UUID)

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$
referenceNumber
string
required
conversationId
string | null
required

Unique identifier (UUID)

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$
voiceCallId
string | null
required

Unique identifier (UUID)

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$
contactId
string | null
required

Unique identifier (UUID)

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$
excludedFromReporting
boolean
required
manuallyExcludedFromReporting
boolean
required
instantBooking
boolean
required
customerName
string | null
required
firstName
string | null
required
lastName
string | null
required
phoneNumber
string
required
serviceAddress
string | null
required
serviceAddressLine1
string | null
required
serviceAddressLine2
string | null
required
serviceCity
string | null
required
serviceState
string | null
required
serviceZipCode
string | null
required
jobTypeId
string | null
required

Unique identifier (UUID)

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$
jobTypeName
string | null
required
jobClassName
string | null
required
onlineBookingFormId
string | null
required

Unique identifier (UUID)

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$
bookingFormSubmissionId
string | null
required

Unique identifier (UUID)

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$
jobTypeFreetext
string | null
required
availabilityWindows
object[]
required
serviceNeeded
string | null
required
emailAddress
string | null
required
preferredTimeWindow
string | null
required
isExistingCustomer
boolean | null
required
channel
enum<string> | null
required
Available options:
web_chat,
voice_call,
booking_form
leadSourceId
string | null
required

Unique identifier (UUID)

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$
leadSourceName
string | null
required
conversationSummary
string | null
required
customFields
object
required
status
enum<string>
required
Available options:
needs_info,
ready_to_schedule,
scheduled,
completed,
canceled
createdAt
string
required
updatedAt
string | null
required
fsmJobLeadGuid
string | null
required
fsmRecord
object
required
bookingDetails
object
required