Campaigns
Change campaign
Move prospect to selected campaign
post/prospects/{prospect}/campaign/{campaign}
Request
- Base URL: http://bonzo.site/api/v3
- URL: http://bonzo.site/api/v3/prospects/{prospect}/campaign/{campaign}
- Auth: HTTP bearer
Path parameters
prospectstring required
Example:1
campaignstring required
Example:2
Response
Success
Example response
{
"data": {
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"avatar": "https://via.placeholder.com/128x128",
"source": "api",
"email": "johndoe@example.com",
"email_type": "valid",
"phone": "1112223333",
"phone_type": "mobile",
"status": "non-active",
"address": "Street Name",
"city": "Los Angeles",
"birthday": "2022-01-01",
"state": "California",
"zip": "001122",
"assigned_user": {
"name": "John Doe",
"email": "johndoe@example.com",
"phone": "1112223333",
"avatar_url": "https://via.placeholder.com/128x128"
},
"last_contact": "2022-01-01T01:00:00.000000Z",
"last_conversation": "2022-01-01T01:00:00.000000Z",
"last_subject": "Last subject",
"timezone": "America/New_York",
"field_1": "Custom field 1",
"field_2": "Custom field 2",
"field_3": "Custom field 3",
"field_4": "Custom field 4",
"field_5": "Custom field 5",
"shared_users": [
{
"name": "John Doe",
"email": "johndoe@example.com",
"phone": "1112223333",
"avatar_url": "https://via.placeholder.com/128x128"
}
],
"created_at": "2022-01-01T01:00:00.000000Z",
"updated_at": "2022-01-01T01:00:00.000000Z",
"business": {
"name": "Business name"
},
"campaigns": [
{
"name": "Campaign name"
}
],
"tags": [
{
"name": "Tag name"
}
],
"conversationalist": {
"name": "John Doe",
"email": "johndoe@example.com",
"phone": "1112223333",
"avatar_url": "https://via.placeholder.com/128x128"
},
"pipeline": {
"name": "Pipeline name"
},
"pipeline_stage": {
"name": "Pipeline stage name"
},
"custom_status": {
"name": "Rejected",
"created_at": "2022-01-01T01:00:00.000000Z",
"updated_at": "2022-01-01T01:00:00.000000Z"
},
"custom_sub_status": {
"name": "Too low CS",
"created_at": "2022-01-01T01:00:00.000000Z",
"updated_at": "2022-01-01T01:00:00.000000Z"
},
"mortgage": {
"company_name": "company_name",
"birthday": "birthday",
"zip": "zip",
"loan_amount": "$425000",
"down_payment": "$125000",
"loan_program": "25yr",
"credit_score": "750",
"loan_type": "fixed",
"loan_purpose": "loan_purpose",
"property_value": "$550000",
"property_address": "Example street 10",
"property_unit_number": "7",
"property_city": "NYC",
"property_state": "New York State",
"property_zip": "10001",
"property_county": "Queens",
"agent_name": "John Doe",
"lead_source": "Bonzo",
"interest_rate": "3.5",
"requested_apr": "4.5",
"property_type": "single home",
"property_use": "house",
"bankruptcy_details": "none",
"occupation": "Programmer",
"household_income": "$250k+",
"current_step": "looking for home",
"purchase_price": "purchase_price",
"cash_out_amount": "cash_out_amount",
"application_date": "01/20/2022",
"close_date": "2022-01-20"
},
"recruiting": {
"prospect_id": "1",
"job_title": "Job title",
"company_name": "Company name",
"linkedin_url": "https://example.com",
"start_date": "2022-01-01T01:00:00.000000Z",
"nmls": "nmls",
"consumer_facing": "Consumer facing",
"types_of_loan": "Types of loan",
"volume_monetary": "Volume monetary",
"volume_amount": "Volume amount",
"software_utilized": "Software utilized",
"lead_sources": "Lead sources",
"state_licenses": "State licenses",
"compensation_range": "Compensation range"
},
"insurance": {
"prospect_id": "1",
"referral_source": "Zapier",
"company_name": "Platypus Industries",
"zip": "10001",
"insurance_city": "New York",
"insurance_state": "NY",
"insurance_address": "Example street 10",
"birthday": "1970-01-01",
"apartment_number": "10",
"marital_status": "married",
"height": "180cm",
"weight": "160lb",
"income": "$2000000",
"occupation": "Programmer",
"work_phone": "1112223333",
"net_worth": "$750000",
"created_at": "2022-01-01T01:00:00.000000Z",
"updated_at": "2022-01-01T01:00:00.000000Z",
"credit_standing": "$50000",
"deductible": "$50000",
"coverage_amount": "$200000",
"liability_amount": "$500000",
"occupancy_status": "occupancy_status",
"property_use": "house",
"property_type": "single home",
"license_status": "license_status"
},
"custom": [
{
"body": "Custom field value"
}
],
"contact_information": [
{
"type": "email",
"content": "johndoe@example.com",
"phone_type": "valid",
"email_type": "valid",
"created_at": "2022-01-01T01:00:00.000000Z",
"updated_at": "2022-01-01T01:00:00.000000Z"
}
]
}
}Changes
No recorded changes to this operation across all 1 revision of this API.