Skip to main content
PATCH
/
contacts
/
{id}
/
lead-source
Update contact lead source
curl --request PATCH \
  --url https://ai-api.getbreezyapp.com/api/v1/contacts/{id}/lead-source \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "leadSourceId": "<string>"
}
'
{
  "id": "<string>",
  "referenceNumber": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "companyName": "<string>",
  "email": "<string>",
  "phoneNumber": "<string>",
  "leadSourceId": "<string>",
  "leadSourceName": "<string>",
  "excludedFromReporting": true,
  "manuallyExcludedFromReporting": true,
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "serviceRequests": [
    {
      "id": "<string>",
      "customerName": "<string>",
      "status": "<string>",
      "channel": "<string>",
      "excludedFromReporting": true,
      "manuallyExcludedFromReporting": true,
      "createdAt": "<string>"
    }
  ],
  "conversations": [
    {
      "id": "<string>",
      "status": "<string>",
      "category": {
        "name": "<string>"
      },
      "excludedFromReporting": true,
      "manuallyExcludedFromReporting": true,
      "createdAt": "<string>",
      "lastActivityAt": "<string>"
    }
  ],
  "voiceCalls": [
    {
      "id": "<string>",
      "status": "<string>",
      "category": {
        "name": "<string>"
      },
      "callerPhoneNumber": "<string>",
      "excludedFromReporting": true,
      "manuallyExcludedFromReporting": true,
      "startedAt": "<string>",
      "endedAt": "<string>"
    }
  ]
}

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
firstName
string | null
required
lastName
string | null
required
companyName
string | null
required
email
string | null
required
phoneNumber
string | null
required
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
excludedFromReporting
boolean
required
manuallyExcludedFromReporting
boolean
required
createdAt
string
required
updatedAt
string | null
required
serviceRequests
object[]
required
conversations
object[]
required
voiceCalls
object[]
required