Links

Prospect API

The prospect API allows you to create, update and delete a prospect.
The prospect object is under the CRM scope, and so is the API. The API requires authentication using the API key. Learn more about authentication. In this guide, you will see how to make API requests to create, edit and delete prospects from your account.
Name
Endpoint
Req. type
Link to detail
Add new prospect
https://api.closershq.io/v1/crm/prospect
POST
Update prospect
https://api.closershq.io/v1/crm/prospect
PATCH
Delete prospect
https://api.closershq.io/v1/crm/prospect
DELETE
This operation adds a new prospect to your CRM. Adding will fail if a prospect with the specified email already exists.
post
https://api.closershq.io/v1/crm
/prospect
Add prospect if not already exist
As in the API card above, only the email field is required. Every other field is optional.
The otherAttribute field is where you added other attributes about the prospect for personalising email contents.

Update prospect:

This operation allows you to update a prospect's basic info and status.
patch
https://api.closershq.io/v1/crm
/prospect
As in the API card above, only the email field is required. Every other field is optional.
The otherAttribute field is where you added other attributes about the prospect for personalizing email contents.

Delete prospect:

This operation removes the prospect from your account, including any campaign they may be part of. This action is irreversible.
delete
https://api.closershq.io/v1/crm
/prospect
Delete prospect profile
Need help? Reach out to us via the chat box from your logged-in account or contact us via [email protected]