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.
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.
Add prospect if not already exist
POST https://api.closershq.io/v1/crm/prospect
Headers
Authorization*
String
Bearer {{apiKey}}
Request Body
email*
String
The prospect's email
firstName
String
The prospect's first name
lastName
String
The prospect's last name
otherAttribute
Object
Object containing other attributes about the 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 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
Headers
Authorization*
String
Bearer {{apiKey}}
Request Body
email*
String
The prospect's email to update
firstName
String
The prospect's first name
lastName
String
The prospect's last name
title
String
The prospect's title
bounced
Boolean
true if prospect email bounced
openedEmail
Boolean
true if prospect opened email
replied
Boolean
true if prospect replied any email
isContacted
Boolean
true if prospect has ever been contacted
unSubscribed
Boolean
true if prospect has unsubscribed
otherAttribute
Object
object container other attributes of the 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 prospect profile
DELETE https://api.closershq.io/v1/crm/prospect
Headers
Authorization*
String
Bearer {{apiKey}}
Request Body
String
The prospect email
Need help? Reach out to us via the chat box from your logged-in account or contact us via support@closershq.io
Last updated