Prospects and ProspectLists not available through the V8 modules API #4493

Open
opened 2026-02-20 16:18:17 -05:00 by deekerman · 3 comments
Owner

Originally created by @shaung999 on GitHub (Mar 1, 2021).

Issue

I need to query a target (Prospect) by email as a response to a campaign, however, it seems there is no access to Prospects or ProspectList API, when I issue a {suite.url}/V8/meta/modules request neither Prospects (Targets) nor ProspectLists (Target lists) are returned in the available modules.

Expected Behavior

I should be able to interact with Prospects in the same way I can with Leads or Contacts.

Actual Behavior

Nothing as the modules are not available

Possible Fix

My first assumption was that the this was an ACL issue as the module appeared in the $moduleList, however, after step by step debugging through the whole process I found that that actual issue was the $modInvisList (also in globals) contained both Prospects and ProspectLists (and a number of other modules), which implies at some point it was decided not to include these, by removing both of these from the $modInvisList they became available and during my testing (mainly create, search and get) they seem to function exactly as Leads and Contacts.

I am raising this bug report so that I can provide a hot-fix for review but also (as I am very new to this product) to ensure that I have not missed something fundamental.

Steps to Reproduce

Any call to {suite.url}/V8/meta/modules.

Please see this link for the full commentary on the issue

Context

I am using my workaround until this is updated as I have an extremely complex target management process that runs across a number of different systems, so for me personally this was a V. HIGH requirement, but for the general use I guess this would be MEDIUM

Your Environment

  • SuiteCRM Version used: 7.11.18 - Sugar Version 6.5.25 (Build 344)
Originally created by @shaung999 on GitHub (Mar 1, 2021). #### Issue I need to query a target (Prospect) by email as a response to a campaign, however, it seems there is no access to Prospects or ProspectList API, when I issue a {suite.url}/V8/meta/modules request neither Prospects (Targets) nor ProspectLists (Target lists) are returned in the available modules. #### Expected Behavior I should be able to interact with Prospects in the same way I can with Leads or Contacts. #### Actual Behavior Nothing as the modules are not available #### Possible Fix My first assumption was that the this was an ACL issue as the module appeared in the $moduleList, however, after step by step debugging through the whole process I found that that actual issue was the $modInvisList (also in globals) contained both Prospects and ProspectLists (and a number of other modules), which implies at some point it was decided not to include these, by removing both of these from the $modInvisList they became available and during my testing (mainly create, search and get) they seem to function exactly as Leads and Contacts. I am raising this bug report so that I can provide a hot-fix for review but also (as I am very new to this product) to ensure that I have not missed something fundamental. #### Steps to Reproduce Any call to {suite.url}/V8/meta/modules. [Please see this link for the full commentary on the issue](https://community.suitecrm.com/t/prospects-targets-not-available-when-performing-a-meta-module-list/78524) #### Context I am using my workaround until this is updated as I have an extremely complex target management process that runs across a number of different systems, so for me personally this was a V. HIGH requirement, but for the general use I guess this would be MEDIUM #### Your Environment * SuiteCRM Version used: 7.11.18 - Sugar Version 6.5.25 (Build 344)
Author
Owner

@rmetcalf9 commented on GitHub (Dec 6, 2023):

I want to be able to add a lead to a target list via the api as well.

@rmetcalf9 commented on GitHub (Dec 6, 2023): I want to be able to add a lead to a target list via the api as well.
Author
Owner

@chris001 commented on GitHub (Dec 6, 2023):

Normally, when a Prospect responds to a Campaign, you convert (upgrade) that Prospect to a Lead.

@chris001 commented on GitHub (Dec 6, 2023): Normally, when a Prospect responds to a Campaign, you convert (upgrade) that Prospect to a Lead.
Author
Owner

@rmetcalf9 commented on GitHub (Dec 7, 2023):

Yes, after bashing my head against a brick wall looking for an API I found that I could use SuiteCRM workflow to automatically add new leads to target lists. I was able to put descriptions into the lead record and have the workflow trigger on the description and add to the right target list.
Very annoying but it forced me to learn the suiteCRM workflow feature which is very powerful and easy to use.
Still, the functionality should be in an API.

@rmetcalf9 commented on GitHub (Dec 7, 2023): Yes, after bashing my head against a brick wall looking for an API I found that I could use SuiteCRM workflow to automatically add new leads to target lists. I was able to put descriptions into the lead record and have the workflow trigger on the description and add to the right target list. Very annoying but it forced me to learn the suiteCRM workflow feature which is very powerful and easy to use. Still, the functionality should be in an API.
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/SuiteCRM-SuiteCRM#4493
No description provided.