client-referrals

Update Client Referral Status

Update client referral status (founder or recruiter).

When status changes to "Signed" and the referral has a converted_company_id, the reward is automatically calculated and applied as a Stripe customer balance credit (auto-deducted from the next invoice).

patch/api/client-referrals/{referral_id}/status

Request

  • Base URL: https://api.ruzora.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.ruzora.com/api/client-referrals/{referral_id}/status
  • Auth: HTTP bearer

Path parameters

referral_idstring required

Request body

status'Submitted' | 'Qualified' | 'Contacted' | 'Demo_Scheduled' | 'Proposal_Sent' | 'Signed' | 'Lost' | 'Rejected' nullable
qualification_notesstring nullable

Founder notes

assigned_tostring nullable

User ID of founder handling this

demo_datestring nullable

Scheduled demo date (ISO format)

signed_datestring nullable

When deal closed (ISO format)

lost_reasonstring nullable

Why we lost the deal

converted_company_idstring nullable

Created company record ID

Response

Successful Response

idstring required

Record ID

referral_type'Client' | 'Candidate' required
referrer_namestring required

Name of person who referred

referrer_companystring nullable

Referrer's company (if client)

referred_company_namestring required
referred_contact_namestring required
referred_contact_emailstring required
referred_contact_titlestring nullable
referred_company_domainstring required
referred_company_sizestring required
referred_industrystring required
estimated_pricing_tierstring required
referral_reasonstring nullable
specific_needstring nullable
statusstring required
qualification_scoreinteger required

Qualification score 0-100

qualification_notesstring nullable
assigned_tostring nullable
demo_datestring nullable
signed_datestring nullable
lost_reasonstring nullable
converted_company_idstring nullable
reward_tierstring nullable
reward_amountnumber nullable
reward_statusstring required
reward_paid_datestring date-time nullable
reward_payment_idstring nullable
created_atstring date-time required
updated_atstring date-time nullable
estimated_rewardstring required

Display text like '$2,000'

status_historyobject[]

Status change history

auto_rewardobject nullable

Auto-reward result when status changed to Signed

Changes

No recorded changes to this operation across all 1 revision of this API.