Find here the list of actions to apply on the objects, and the data reference for this object.

What is a lead ?

A lead contains information (amount of sale, signing date, expectations) on a sales prospect or a client, and it's linked to a contact or firm.

Getting the leads list

GET /leads.xml

Returns all leads, page by page
Add a page parameter to navigate

Getting a single lead

GET /leads/#{id}.xml

Returns a single lead, identified by its id

Creating a new lead

POST /leads.xml

Creates a new lead, and returns the lead data

Updating an existing lead

PUT /leads/#{id}.xml

Updates some fields of an existing lead

Deleting an existing lead

DELETE /leads/#{id}.xml

Deletes the lead identified by its id

Object data

<lead>
 <id>id of this object</id>
 <manager_id>user id of the manager of the lead</manager_id>
 <client_name>Name of client</client_name>
 <topic>Topic of this lead</topic>
 <contact_id>id of related contact (or 0)</firm_id>
 <firm_id>id of related firm (or 0)</firm_id>
 <is_engaged>0 for prospect, 1 for customer</is_engaged>
 <importance>0 not important to 5 most important</importance>
 <product_category_id>id in your own typology of products you sell</category>
 <value>amount of sale without taxes</value>
 <value_date>expected date of signing the sale</value_date>
 <confidence_pct>percentage of confidence (0-100)</confidence_pct>
 <project_id>id of related project</project_id>
 <description>Some description of the lead</description>
 <learning_on_customer>Some info about the customer (budget, timing, etc.)</learning_on_customer>
 <learning_on_sales_tools>Some learnings on your own sales tools (website, brochures, etc.)</learning_on_sales_tools>
 <learning_on_products>Some learnings on your products (too expensive, etc.)</learning_on_products>
</lead>

Possible values of steps for leads

• 459 for project

• 460 for analysis

• 461 for proposal

• 462 for negociation

• 463 for closing

• 464 for production

• 467 for exploitation

• 469 for done

• 470 for lost

• 535 for sleeping