Endpoint: {{Base URL}}/client/{client_id}/application
Method: POST
Description: Start an application for an existing prospect
Payload:
{ "service_id": 3, "vendor_id": 30, "product_id": 1616, "vendor_branch_id": 124, "additional_courses": [ { "product_id": 106795, "partner_branch_id": 265, "partner_id": 60, "sort_order": 1 }, { "product_id": 6692, "partner_branch_id": 445, "partner_id": 126, "sort_order": 2 }, { "product_id": 1897, "partner_branch_id": 137, "partner_id": 35, "sort_order": 3 } ] } |
Response
{ "data": { "client_id": 8, "product_id": 1616, "vendor_branch_id": 124, "service_id": 3, "current_stage": 11, "stage_updated_at": "2025-10-08T06:33:49.308280Z", "applied_intake_date": null, "expected_win_date": null, "super_agent_id": null, "product_type": "Course", "progression_course": null, "current_stage_name": "Document application", "workflow_name": "Australian Education Test", "product_name": "Bachelor of Combined Studies in Commerce \/ Information Technology", "partner_name": "Ability English", "partner_branch_name": "North Ryde Campus", "creator_id": 199, "added_by_branch_id": 2, "creator_name": "Sazynanana Joshi", "creator_email": "[email protected]", "updated_at": "2025-10-08T06:33:49.000000Z", "created_at": "2025-10-08T06:33:49.000000Z", "id": 4652, "referrer_id": 1, "client": { "id": 8, "uuid": "", "first_name": "Mina", "last_name": "Chen", "email": "[email protected]", "secondary_email": null, "user_id": 1, "phone": null, "country_of_passport": 44, "dob": "1993-01-05", "education_background": null, "employment_background": null, "first_point_of_contact": "Phone", "rating": { "value": 2, "label": "Warm" }, "created_at": "2018-05-02T01:52:07.000000Z", "updated_at": "2025-10-08T06:26:57.000000Z", "photo": "", "street": "2\/36 Mary Street", "city": "Sydney", "state": "NSW", "zip_code": "2140", "country": 44, "assigned_to": 13, "comment": "", "commented_at": null, "preferred_intake": "2024-05-01", "archived_on": null, "archived_by": null, "client_identifier": null, "visa_expiry_date": "2023-11-01", "visa_type": "Student", "status": { "value": 1, "label": "Client" }, "branch_id": 1, "passport_number": null, "tag": "system", "enquired_at": null, "prospected_at": null, "application_added_at": null, "portal_enabled": 1, "password": "$2y$10$zBQqlDAd.EAs70CDkeeEwu8CmubKXqPoNbPwFBItXQOKNePOW7dBq", "remember_token": null, "phone_number_country_code": null, "gender": null, "photo_url": null }, "product": { "id": 1616, "vendor_id": 30, "created_at": "2021-03-18T00:48:47.000000Z", "updated_at": "2024-06-05T08:04:37.000000Z", "name": "Bachelor of Combined Studies in Commerce \/ Information Technology", "short_name": "", "service_fee": "0.00", "notes": null, "description": null, "general_service_product_id": null, "subject_id": 76, "degree_level_id": 7, "minimum_degree_level_id": null, "academic_score": null, "academic_score_type": null, "intake_month": [], "duration": "208 weeks", "revenue_type": 2, "product_category_id": 9, "master_id": null, "status": 1, "deleted_at": null, "partner": { "id": 30, "name": "Ability English", "service_id": null, "phone_number": "(02) 9211 4161", "email": "[email protected]", "fax": null, "created_at": "2021-03-18T00:48:43.000000Z", "updated_at": "2025-03-21T10:56:59.000000Z", "logo": "https:\/\/agentcisapp.s3.ap-southeast-2.amazonaws.com\/import\/partner\/logo\/Vp1pmI1cD4bLssvpPpurhPmAROQkxhAfXB8YRnJm.png", "street": "10 Quay Street", "city": "Sydney", "state": "New South Wales", "zip_code": "2000", "country": 11, "website": "www.ability.edu.au", "commission_percentage": "0.00", "business_registration_number": null, "display_options": { "pdf": { "show_business_registration_number": false } }, "currency_code": "AUD", "category_id": null, "contract_expiry_date": null, "super_agent_id": null, "partner_category_id": 2, "master_id": 254, "auto_sync": true, "source": "import", "status": 1, "phone_number_country_code": null } }, "branch": { "id": 124, "phone_number": "(02) 9850 7346", "email": "[email protected]", "type": "Other Office", "vendor_id": 30, "created_at": "2021-03-18T00:48:43.000000Z", "updated_at": "2024-06-05T08:04:37.000000Z", "street": "Corner Herring & Balaclava Roads", "state": "New South Wales", "city": "North Ryde", "zip_code": "2109", "country": 11, "name": "North Ryde Campus", "master_id": null, "status": 1, "phone_number_country_code": null, "address": "Corner Herring & Balaclava Roads, North Ryde, New South Wales, 2109, Australia", "nation": { "id": 11, "country_name": "Australia", "currency_name": "Australian dollar", "currency_code": "AUD", "country_code": "AU", "country_dialing_code": "61", "country_code_iso_alpha3": "AUS" } }, "creator": { "id": 199, "first_name": "Sazynanana", "last_name": "Joshi", "job_title": "SajinaTest", "email": "[email protected]", "phone_number": null, "created_at": "2023-05-01T11:30:29.000000Z", "updated_at": "2025-10-08T06:09:33.000000Z", "branch_id": 2, "status": 1, "email_signature": null, "photo": "89aac0182799cd0cf37eabe4e17064a2.png", "added_by": 33, "is_owner": 1, "last_session_id": "9hXLKEvzrcwQLNbBt8RF2oTsOyGmzcT2zmexAHqy", "onboarding_completed": 1, "timezone": "Asia\/Kathmandu", "phone_number_country_code": null, "name": "Sazynanana Joshi", "branch": { "id": 2, "name": "Sydney Development Committee Office - Melbourne", "mobile": "", "landline": "", "person_to_contact": "James Cook", "created_at": "2018-05-09T06:36:40.000000Z", "updated_at": "2025-05-22T05:37:06.000000Z", "street": "Mary Street", "city": "Sydney", "zip_code": "2142", "country": "11", "deleted_at": null, "added_by": 1, "state": "NSW", "email": "[email protected].aus", "business_registration_number": "5243" } }, "added_by_branch": { "id": 2, "name": "Sydney Development Committee Office - Melbourne", "mobile": "", "landline": "", "person_to_contact": "James Cook", "created_at": "2018-05-09T06:36:40.000000Z", "updated_at": "2025-05-22T05:37:06.000000Z", "street": "Mary Street", "city": "Sydney", "zip_code": "2142", "country": "11", "deleted_at": null, "added_by": 1, "state": "NSW", "email": "[email protected].aus", "business_registration_number": "5243" }, "service": { "id": 3, "name": "Australian Education Test", "product_name": "Courses", "vendor_name": "Institutions", "status": 1, "currency_code": "AUD", "share_to_all_office": 0, "document_checklist_template": { "id": 1, "workflow_id": 3, "user_id": 1, "created_at": "2021-09-21T23:58:04.000000Z", "updated_at": "2022-06-01T10:04:38.000000Z", "status": 1, "items": [ { "id": 7, "document_type_id": 6, "description": "Test", "is_applied_to_all_partners": 1, "is_applied_to_all_products": 1, "allow_client_upload": 1, "is_mandatory": 0, "status": 1, "template_id": 1, "workflow_stage_id": 12, "created_at": "2021-09-22T01:17:44.000000Z", "updated_at": "2021-09-22T02:49:58.000000Z" }, { "id": 31, "document_type_id": 14, "description": "cnidcbi", "is_applied_to_all_partners": 0, "is_applied_to_all_products": 0, "allow_client_upload": 1, "is_mandatory": 1, "status": 1, "template_id": 1, "workflow_stage_id": 76, "created_at": "2022-01-24T02:54:09.000000Z", "updated_at": "2022-01-24T02:54:09.000000Z" }, { "id": 37, "document_type_id": 21, "description": "sdfvb", "is_applied_to_all_partners": 1, "is_applied_to_all_products": 1, "allow_client_upload": 1, "is_mandatory": 1, "status": 1, "template_id": 1, "workflow_stage_id": 94, "created_at": "2022-02-04T10:40:08.000000Z", "updated_at": "2023-11-21T10:13:25.000000Z" }, { "id": 38, "document_type_id": 19, "description": "fghjk", "is_applied_to_all_partners": 1, "is_applied_to_all_products": 1, "allow_client_upload": 1, "is_mandatory": 1, "status": 1, "template_id": 1, "workflow_stage_id": 94, "created_at": "2022-02-04T10:40:20.000000Z", "updated_at": "2023-11-21T10:13:28.000000Z" }, { "id": 39, "document_type_id": 6, "description": "edrftghj", "is_applied_to_all_partners": 1, "is_applied_to_all_products": 1, "allow_client_upload": 1, "is_mandatory": 1, "status": 1, "template_id": 1, "workflow_stage_id": 94, "created_at": "2022-02-04T10:40:32.000000Z", "updated_at": "2023-11-21T10:13:32.000000Z" }, { "id": 104, "document_type_id": 119, "description": "sdfsd", "is_applied_to_all_partners": 1, "is_applied_to_all_products": 1, "allow_client_upload": 0, "is_mandatory": 0, "status": 1, "template_id": 1, "workflow_stage_id": 14, "created_at": "2023-08-04T05:21:51.000000Z", "updated_at": "2023-08-04T05:21:51.000000Z" }, { "id": 105, "document_type_id": 120, "description": "wewe", "is_applied_to_all_partners": 1, "is_applied_to_all_products": 1, "allow_client_upload": 1, "is_mandatory": 0, "status": 1, "template_id": 1, "workflow_stage_id": 15, "created_at": "2023-08-04T05:34:48.000000Z", "updated_at": "2023-08-04T05:34:48.000000Z" }, { "id": 112, "document_type_id": 135, "description": "mjj", "is_applied_to_all_partners": 1, "is_applied_to_all_products": 1, "allow_client_upload": 0, "is_mandatory": 0, "status": 1, "template_id": 1, "workflow_stage_id": 11, "created_at": "2024-03-28T01:43:37.000000Z", "updated_at": "2025-01-10T06:07:16.000000Z" }, { "id": 133, "document_type_id": 146, "description": "fcgvh", "is_applied_to_all_partners": 1, "is_applied_to_all_products": 1, "allow_client_upload": 0, "is_mandatory": 0, "status": 1, "template_id": 1, "workflow_stage_id": 94, "created_at": "2025-05-29T05:01:46.000000Z", "updated_at": "2025-05-29T05:01:46.000000Z" } ] } }, "stages": [ { "short_name": "Document application", "order": 0, "status": 1, "application_id": 4652, "id": 22789, "application_stage_id": 22789, "stage_id": 11 }, { "short_name": "Offer Letter Received", "order": 1, "status": 1, "application_id": 4652, "id": 22790, "application_stage_id": 22790, "stage_id": 12 }, { "short_name": "Offer Letter Accepted", "order": 2, "status": 1, "application_id": 4652, "id": 22794, "application_stage_id": 22794, "stage_id": 76 }, { "short_name": "COE Stage", "order": 3, "status": 1, "application_id": 4652, "id": 22795, "application_stage_id": 22795, "stage_id": 94 }, { "short_name": "Visa Application", "order": 4, "status": 1, "application_id": 4652, "id": 22791, "application_stage_id": 22791, "stage_id": 13 }, { "short_name": "Enrollment", "order": 5, "status": 1, "application_id": 4652, "id": 22792, "application_stage_id": 22792, "stage_id": 14 }, { "short_name": "Course", "order": 6, "status": 1, "application_id": 4652, "id": 22793, "application_stage_id": 22793, "stage_id": 15 }, { "short_name": "New step", "order": 7, "status": 1, "application_id": 4652, "id": 22798, "application_stage_id": 22798, "stage_id": 509 }, { "short_name": "SUbmission", "order": 8, "status": 0, "application_id": 4652, "id": 22796, "application_stage_id": 22796, "stage_id": 115 }, { "short_name": "Test", "order": 9, "status": 0, "application_id": 4652, "id": 22797, "application_stage_id": 22797, "stage_id": 248 }, { "short_name": "sdfsdf", "order": 10, "status": 1, "application_id": 4652, "id": 22799, "application_stage_id": 22799, "stage_id": 633 }, { "short_name": "ewwew", "order": 11, "status": 0, "application_id": 4652, "id": 22800, "application_stage_id": 22800, "stage_id": 645 } ], "referrer": { "id": 1, "name": "ABC Education", "phone": null, "email": "[email protected]", "photo": "178fadc27e31e0ae6464c5a9c9911c70.jpeg", "street": "", "city": "Sydney", "state": "NSW", "zip_code": "2000", "country": 11, "income_sharing_percentage": "80.00", "deleted_at": null, "created_at": "2018-05-06T07:40:10.000000Z", "updated_at": "2025-07-15T08:30:58.000000Z", "type": "business", "tax_number": "", "contract_expiry_date": "0000-00-00", "agent_type": [ 1, 2 ], "claim_revenue_percentage": "80.00", "phone_number_country_code": null, "connection_status": "request_sent", "photo_url": "https:\/\/agentcisapp.s3.ap-southeast-2.amazonaws.com\/e2111f0d-2beb-403e-8802-771d2db53931\/uploads\/referrers\/photo\/178fadc27e31e0ae6464c5a9c9911c70.jpeg", "address": "Sydney, NSW, 2000, Australia", "nation": { "id": 11, "country_name": "Australia", "currency_name": "Australian dollar", "currency_code": "AUD", "country_code": "AU", "country_dialing_code": "61", "country_code_iso_alpha3": "AUS" } } }, "message": "Application added successfully" } |
Status: 400, 403, 200
Endpoint: {{Client Base URL}}/{client_id}/applications
Method: Get
Description: List of all the applied applications by the client
Response
{ “data”:{}, "message": "Application added successfully" } |
Status: 400, 403, 200
Endpoint: {{Application Base URL}}/{application_id}/partner-update
Method: PUT
Description: Update a specific application of a client
Payload
{ "service_id": 3, "vendor_id": 30, "product_id": 1616, "vendor_branch_id": 124, "additional_courses": [ { "product_id": 106795, "partner_branch_id": 265, "partner_id": 60, "sort_order": 1 }, { "product_id": 6692, "partner_branch_id": 445, "partner_id": 126, "sort_order": 2 }, { "product_id": 1897, "partner_branch_id": 137, "partner_id": 35, "sort_order": 3 } ] } |
Response
{ "custom_fields": null, "id": 4652, "application_id": null, "status": "In Progress", "product": { "id": 1616, "name": "Bachelor of Combined Studies in Commerce \/ Information Technology", "branch": "North Ryde Campus", "branch_id": 124, "partner_name": "Ability English", "revenue_type": null }, "workflow": { "id": 3, "name": "Australian Education Test", "product_name": null, "vendor_name": null }, "progression_courses": { "id": 106795, "name": "Bachelor of Business (Accounting)" }, "progression_partners": { "vendor_id": 60, "vendor_name": "Acknowledge Education", "branch_id": 265, "branch_name": "Sydney - Barangaroo Campus" }, "additional_courses": [ { "id": 23, "product_id": 1897, "partner_branch_id": 137, "partner_id": 35, "sort_order": 3, "product": { "id": 1897, "name": "Level 1 - Session 1-3: MYOB" }, "branch": { "id": 137, "name": "Adelaide Office" }, "partner": { "id": 35, "name": "Accountants Resource Centre (ARC)" } }, { "id": 22, "product_id": 6692, "partner_branch_id": 445, "partner_id": 126, "sort_order": 2, "product": { "id": 6692, "name": "Certificate III in Sport Coaching" }, "branch": { "id": 445, "name": "Broadbeach Waters Campus" }, "partner": { "id": 126, "name": "Ace Sports Academy" } }, { "id": 21, "product_id": 106795, "partner_branch_id": 265, "partner_id": 60, "sort_order": 1, "product": { "id": 106795, "name": "Bachelor of Business (Accounting)" }, "branch": { "id": 265, "name": "Sydney - Barangaroo Campus" }, "partner": { "id": 60, "name": "Acknowledge Education" } } ], "client": { "id": 8, "phone": null, "name": " ", "email": null, "photo": null }, "partner": { "id": 30, "name": "Ability English", "currency_code": null, "commission_percentage": null, "logo": null }, "application_stage_id": null, "current_stage": { "id": 11, "name": "Document application", "order": 0, "status": true, "actions": "{\"note\":false,\"dates\":true,\"application_id\":false,\"applied_intake_date\":false}", "next": null, "previous": null }, "creator": { "id": 199, "email_signature": null, "email": "[email protected]", "name": "Sazynanana Joshi ", "photo": null }, "start_date": null, "end_date": null, "assignees": [ { "id": 199, "name": "Sazynanana Joshi", "email": "[email protected]", "photo": "https:\/\/agentcisapp.s3.ap-southeast-2.amazonaws.com\/e2111f0d-2beb-403e-8802-771d2db53931\/uploads\/users\/photo\/89aac0182799cd0cf37eabe4e17064a2.png", "ownership_ratio": "100.00", "is_owner": 1, "branch_name": "Sydney Development Committee Office - Melbourne" } ], "sub_agent": { "id": 1, "name": "ABC Education", "type": "business", "photo": "https:\/\/agentcisapp.s3.ap-southeast-2.amazonaws.com\/e2111f0d-2beb-403e-8802-771d2db53931\/uploads\/referrers\/photo\/178fadc27e31e0ae6464c5a9c9911c70.jpeg", "email": "[email protected]", "address": { "street": "", "state": "NSW", "city": "Sydney", "phone": null, "country": null }, "currencies": [ "AUD", "USD" ], "connection_status": "request_sent" }, "super_agent": null, "assignee": { "id": 13, "name": "Bishal Sydney", "branch": null }, "completed_stages": null, "stages": [ { "short_name": "Document application", "order": 0, "status": 1, "application_id": 4652, "id": 22789, "application_stage_id": 22789, "stage_id": 11, "document_checklists": [
] }, { "short_name": "Offer Letter Received", "order": 1, "status": 1, "application_id": 4652, "id": 22790, "application_stage_id": 22790, "stage_id": 12, "document_checklists": [ { "id": 7695, "uuid": "", "document_type_id": 6, "description": "Test", "allow_client_upload": 1, "is_mandatory": 0, "due_date": null, "due_time": null, "status": 1, "application_stage_id": 22790, "application_id": 4652, "created_at": "2025-10-08T06:33:49.000000Z", "updated_at": "2025-10-08T06:33:49.000000Z", "document_type": { "id": 6, "name": "Salary Statements", "user_id": null, "status": 0, "created_at": "2021-09-21T11:37:16.000000Z", "updated_at": "2022-04-05T11:39:12.000000Z" } } ] }, { "short_name": "Offer Letter Accepted", "order": 2, "status": 1, "application_id": 4652, "id": 22794, "application_stage_id": 22794, "stage_id": 76, "document_checklists": [
] }, { "short_name": "COE Stage", "order": 3, "status": 1, "application_id": 4652, "id": 22795, "application_stage_id": 22795, "stage_id": 94, "document_checklists": [ { "id": 7696, "uuid": "", "document_type_id": 21, "description": "sdfvb", "allow_client_upload": 1, "is_mandatory": 1, "due_date": null, "due_time": null, "status": 1, "application_stage_id": 22795, "application_id": 4652, "created_at": "2025-10-08T06:33:49.000000Z", "updated_at": "2025-10-08T06:33:49.000000Z", "document_type": { "id": 21, "name": "ABN or ACN", "user_id": 1, "status": 1, "created_at": "2022-01-26T19:08:50.000000Z", "updated_at": "2022-01-26T19:08:50.000000Z" } }, { "id": 7697, "uuid": "", "document_type_id": 19, "description": "fghjk", "allow_client_upload": 1, "is_mandatory": 1, "due_date": null, "due_time": null, "status": 1, "application_stage_id": 22795, "application_id": 4652, "created_at": "2025-10-08T06:33:49.000000Z", "updated_at": "2025-10-08T06:33:49.000000Z", "document_type": { "id": 19, "name": "Proof of Australian Citizenship or Australian Permanent Resident", "user_id": 1, "status": 1, "created_at": "2022-01-26T19:08:28.000000Z", "updated_at": "2022-01-26T19:08:28.000000Z" } }, { "id": 7698, "uuid": "", "document_type_id": 6, "description": "edrftghj", "allow_client_upload": 1, "is_mandatory": 1, "due_date": null, "due_time": null, "status": 1, "application_stage_id": 22795, "application_id": 4652, "created_at": "2025-10-08T06:33:49.000000Z", "updated_at": "2025-10-08T06:33:49.000000Z", "document_type": { "id": 6, "name": "Salary Statements", "user_id": null, "status": 0, "created_at": "2021-09-21T11:37:16.000000Z", "updated_at": "2022-04-05T11:39:12.000000Z" } }, { "id": 7702, "uuid": "", "document_type_id": 146, "description": "fcgvh", "allow_client_upload": 0, "is_mandatory": 0, "due_date": null, "due_time": null, "status": 1, "application_stage_id": 22795, "application_id": 4652, "created_at": "2025-10-08T06:33:49.000000Z", "updated_at": "2025-10-08T06:33:49.000000Z", "document_type": { "id": 146, "name": "Birth certifciate", "user_id": 242, "status": 1, "created_at": "2025-05-21T08:16:00.000000Z", "updated_at": "2025-05-21T08:16:00.000000Z" } } ] }, { "short_name": "Visa Application", "order": 4, "status": 1, "application_id": 4652, "id": 22791, "application_stage_id": 22791, "stage_id": 13, "document_checklists": [
] }, { "short_name": "Enrollment", "order": 5, "status": 1, "application_id": 4652, "id": 22792, "application_stage_id": 22792, "stage_id": 14, "document_checklists": [ { "id": 7699, "uuid": "", "document_type_id": 119, "description": "sdfsd", "allow_client_upload": 0, "is_mandatory": 0, "due_date": null, "due_time": null, "status": 1, "application_stage_id": 22792, "application_id": 4652, "created_at": "2025-10-08T06:33:49.000000Z", "updated_at": "2025-10-08T06:33:49.000000Z", "document_type": { "id": 119, "name": "invoice", "user_id": 200, "status": 1, "created_at": "2023-06-27T01:34:44.000000Z", "updated_at": "2023-06-27T01:34:44.000000Z" } } ] }, { "short_name": "Course", "order": 6, "status": 1, "application_id": 4652, "id": 22793, "application_stage_id": 22793, "stage_id": 15, "document_checklists": [ { "id": 7700, "uuid": "", "document_type_id": 120, "description": "wewe", "allow_client_upload": 1, "is_mandatory": 0, "due_date": null, "due_time": null, "status": 1, "application_stage_id": 22793, "application_id": 4652, "created_at": "2025-10-08T06:33:49.000000Z", "updated_at": "2025-10-08T06:33:49.000000Z", "document_type": { "id": 120, "name": "1234", "user_id": 100, "status": 1, "created_at": "2023-08-04T05:34:42.000000Z", "updated_at": "2023-08-04T05:34:42.000000Z" } } ] }, { "short_name": "New step", "order": 7, "status": 1, "application_id": 4652, "id": 22798, "application_stage_id": 22798, "stage_id": 509, "document_checklists": [
] }, { "short_name": "SUbmission", "order": 8, "status": 0, "application_id": 4652, "id": 22796, "application_stage_id": 22796, "stage_id": 115, "document_checklists": [ ] }, { "short_name": "Test", "order": 9, "status": 0, "application_id": 4652, "id": 22797, "application_stage_id": 22797, "stage_id": 248, "document_checklists": [ ] }, { "short_name": "sdfsdf", "order": 10, "status": 1, "application_id": 4652, "id": 22799, "application_stage_id": 22799, "stage_id": 633, "document_checklists": [
] }, { "short_name": "ewwew", "order": 11, "status": 0, "application_id": 4652, "id": 22800, "application_stage_id": 22800, "stage_id": 645, "document_checklists": [
] } ], "updated_at": { "formatted": "10-08-2025", "actual": "2025-10-08T12:18:49+05:45" }, "created_at": { "formatted": "10-08-2025", "actual": "2025-10-08T12:18:49+05:45" }, "in_queue": 0, "todo_invoices": [
], "discontinue_reason_title": null, "permissions": { "delete": true, "view": true, "viewProductFeeCommission": true, "editProductFeeCommission": true, "viewSalesForecast": true, "editSalesForecast": true, "payment_schedule": { "setup": true, "create": true, "edit": true, "delete": true, "view_commission": true, "edit_commission": true }, "isStudyLinkVisible": false, "canManageStudyLink": true, "canEnrollClassroom": true, "canViewActivityClassroom": true, "canEditApplicationPartner": true }, "partner_category": "Institution", "product_category": "Course", "applied_intake_date": null, "expected_win_date": null, "product_fee": { "id": 117023, "total": 36450, "discount": 0, "net_revenue": 36450, "revenue_type": 2, "has_commission": false }, "payment_schedule": { "count": 0, "total_pending": 0, "total_invoiced": 0, "total_scheduled": 0 }, "studylink": { "is_synced": false, "application_details": [
] }, "session": { "is_session_exist": false, "is_enrolled_to_session": false, "session_id": null, "status": null, "student_id": null }, "sharedApplication": null } |
Endpoint: {{Application Base URL}}/{application_id}/delete
Method: DELETE
Description: List of all the applied applications by the client
Payload:
{ } |
Response
{ } |
Endpoint: {{Application Base URL}}/{applicationId}/{action}
Method: POST
Description: Moves an application to the next, previous, or reverts the current stage with comprehensive validation checks.
Url Parameters :
Parameter | Type | Required | Description | Constraints |
applicationId | integer | Yes | ID of the application to move | Must be numeric |
action | string | Yes | Action to perform | next, previous, or revert |
Payload:
{ noteAdded": true // Required when mandatory note action is set for the stage } |
Response:
{ "data": [], } |
HTTP Status Codes:
- 200 OK: Success
- 401 Unauthorized: Invalid or missing authentication
- 403 Forbidden: Insufficient permissions
- 404 Not Found: Entity not found
Endpoint: {{Application Base URL}}/{applicationId}/status
Method: Patch
Description: Updates the overall status of an application ( Discontinue)
Url Parameters :
Parameter | Type | Required | Description | Constraints |
applicationId | integer | Yes | ID of the application to update | Must be numeric |
Payload:
{ "status": "Discontinue", "next_invoice_due_date": "2024-07-01", // Optional: Date for next invoice "discontinue_reason_id":3, // Optional: ID of discontinue reason "noteAdded": true // Required when mandatory note action is set for the stage" } |
Response:
{ "data": [], } |
HTTP Status Codes:
- 200 OK: Success
- 401 Unauthorized: Invalid or missing authentication
- 403 Forbidden: Insufficient permissions
- 404 Not Found: Entity not found
Endpoint: {{Application Base URL}}/{applicationId}
Method: PUT
Description: Updates various date fields including start/end dates, intake dates, and invoice due dates.
Url Parameters :
Parameter | Type | Required | Description | Constraints |
applicationId | integer | Yes | ID of the application to update | Must be numeric |
For start date and end date
Payload:
{ "start_date": "2024-02-01", "end_date": "2024-07-31", } |
For applied intake date
Payload:
{ "applied_intake_date": "2024-09-01", } |
For expected win date
Payload:
{ "expected_win_date": "2024-08-15", } |
Response:
{ "data": [], //same ad update application } |
HTTP Status Codes:
- 200 OK: Success
- 401 Unauthorized: Invalid or missing authentication
- 403 Forbidden: Insufficient permissions
- 404 Not Found: Entity not found
Endpoint: {{Application Base URL}}/$application_id/assignee
Method: POST
Description: Add unique assignee to application
Payload
{"assignee":203 } //user id can be fetched from List User API |
Response
{} |
