Skip to main content
PATCH
Update lead stages

Authorizations

Authorization
string
header
required

Access token issued by POST /sessions and associated with a valid server-side session.

Path Parameters

id
string<uuid>
required

UUID identifying this resource.

Query Parameters

company_id
string<uuid>
required

Company UUID. Must equal the authenticated session company when that session has a company assigned; the equality check is skipped for sessions without one.

school_id
string<uuid>
required

School UUID. Must be assigned to the authenticated session.

Body

application/json

Update Lead Stages Request.

stage_inquiry_call_completed
boolean
required

true sets the stage, false clears it; omitted or null leaves it unchanged.

stage_tour_completed
boolean | null

true sets the stage, false clears it; omitted or null leaves it unchanged.

stage_not_interested
boolean | null

true sets the stage, false clears it; omitted or null leaves it unchanged.

stage_not_viable
boolean | null

true sets the stage, false clears it; omitted or null leaves it unchanged.

stage_no_response
boolean | null

true sets the stage, false clears it; omitted or null leaves it unchanged.

stage_no_response_timed_out
boolean | null

true sets the stage, false clears it; omitted or null leaves it unchanged.

Response

Successful response.

stage
string
required

Stage name. The GET response can include source-specific stage names; PATCH accepts only its six documented stage properties.

value
string | null
required

Source stage state as a string or null, rather than the boolean used by PATCH.

updated_at
string<date-time> | null
required