Reprocess leads via REST API

Follow

This feature allows you to Reprocess leads via our REST API, another feature which assists you with automating your processes!

Getting Started

In order to Reprocess via the REST API, you'll need a REST API key with the correct permissions.

Head to the Admin tab > Tech Hub > REST API to get started:

1) Create yourself an Administrator Key

2) Ensure the Administrator Key has the Leads > Reprocess permission

3) Activate your Administrator Key

Request

The instructions for your request will be generated at the bottom of the REST API key settings page

LeadByte - Edit REST API Key and 3 more pages - Personal 2 - Microsoft_ Edg.. 2024-06-18 at 2.42.42 PM

You are also provided with two example requests:

1. Reprocess a single lead:

[POST] https://domain.leadbyte.com/restapi/v1.3/leads/reprocess
{
 
"leadId": LeadID here
}


Headers:
X_KEY: API KEY HERE

Example Response

{
	"status": "Success",
	"message": "",
	"details": {
		"8419715": "Queued for reprocessing"
	}
}

2. Reprocess multiple leads:

[POST] https://domain.leadbyte.com/restapi/v1.3/leads/reprocess
{
	
	"leadIds": [
		LeadID here,
		LeadID here
	]
}

Headers:
X_KEY: API KEY HERE

Example Response

{
	"status": "Success",
	"message": "",
	"details": {
		"8419714": "Queued for reprocessing",
		"8419715": "Queued for reprocessing"
	}
}

 

If you have any questions regarding the above, please raise a Support ticket.

 

 

Was this article helpful?
0 out of 0 found this helpful

Comments