Prospects

Group: CRM

Open in the interactive reference

A prospect is an organization an entity is selling to before it becomes a customer, in the CRM alongside its opportunities and quotes.

Three read endpoints share one item schema: GET crm/prospects/:id, GET crm/prospects and POST crm/prospects/search. GET crm/prospects omits contacts[], every contact of the prospect, which the other two return. POST crm/prospects and PATCH crm/prospects/:id create and change one prospect by the rules of the prospect form in the app; POST crm/prospects/bulk and PATCH crm/prospects/bulk do the same for up to 100 at once, all-or-nothing. A prospect converted to a customer can no longer be changed. Prospects cannot be deleted, as in the app.

Endpoints

• List prospects: GET /crm/prospects
• Create a prospect: POST /crm/prospects
• Bulk create prospects: POST /crm/prospects/bulk
• Bulk update prospects: PATCH /crm/prospects/bulk
• Search prospects: POST /crm/prospects/search
• Retrieve a prospect: GET /crm/prospects/{id}
• Update a prospect: PATCH /crm/prospects/{id}