Operations API

Leads

Leads are linked with Customers. They can be created via dedicated API resources, through the Dashboard, or by integrating a lead capture form on your owned webpage. Both Leads and their corresponding Customer Objects feature properties like 'lead_status' and 'priority', which are useful when developing lead management procedures or sales conversion pathways for your business.

When a lead is associated with an invoice, it's automatically upgraded to a customer.

The Leads API is experimental. Feel free to contact us with any feedback or recommendations.

Endpoints

Description

Method

URL

Create Lead

POST

/v2/leads/create

GET

/v2/leads/retrieve/:id

POST

/v2/leads/update/:id

POST

/v2/leads/bulk/upgrade

POST

/v2/leads/bulk/change-status

POST

/v2/leads/bulk/change-priority

POST

/v2/leads/bulk/assign-to-teammate

DELETE

/v2/leads/:id

GET

/v2/leads/list



Webhook Events

There are three webhook notification events associated with the Leads API.

  • customer-created
  • customer-updated
  • customer-removed

You can see examples of notification events here

Permissions

Since leads are a part of the Customers API, permissions are the same as the ones defined here.