Lead Methods

GET current Returns a list of current leads
GET get/[id] Detailed information for a specific lead
GET list Return a list of all leads
POST add Add a lead
GET categories Return a list of lead categories

 

GET current

 

Parameters:

detailed=true Optional Return detailed information for lead.  See GET get/[id] method for example of detailed lead response.

 

Example URL:

https://api.workflowmax.com/lead.api/current?apiKey=[your API key]&accountKey=[WorkflowMax account key]

 

Example Response:

<Response>
<Status>OK</Status>
 <Leads>
   <Lead>
     <ID>12345</ID>
     <Name>Brochure Design</Name>
     <Description />
     <State>Current</State>
     <EstimatedValue>10000</EstimatedValue>
     <Date>2008-08-29T00:00:00</Date> 
     <DateWonLost />
     <Category>Hot</Category> 
     <Client>
       <ID>5</ID>
       <Name>A C Smith Limited</Name>
     </Client>
     <Contact>
       <ID>123</ID>
       <Name>Andrew Smith</Name>
     </Contact>
     <Owner>
       <ID>5</ID>
       <Name>Jo Bloggs</Name>
     </Owner>
   </Lead>
 </Leads>
</Response>

 

GET get/[id]

 

Example URL:

https://api.workflowmax.com/lead.api/get/1234?apiKey=[your API key]&accountKey=[WorkflowMax account key]

 

Example Response:

<Response>
  <Status>OK</Status> 
  <Lead>
    <ID>12345</ID>
    <Name>Brochure Design</Name>
    <Description />
    <State>Current</State>
    <EstimatedValue>10000</EstimatedValue>
    <Date>2008-08-29T00:00:00</Date> 
    <DateWonLost />
    <Category>Hot</Category> 
    <Client>
      <ID>5</ID>
      <Name>A C Smith Limited</Name>
    </Client>
    <Contact>
      <ID>123</ID>
      <Name>Andrew Smith</Name>
    </Contact>
    <Owner>
      <ID>5</ID>
      <Name>Jo Bloggs</Name>
    </Owner>
    <Activities>
      <Activity>
        <Date>2008-09-24T00:00:00</Date> 
        <Subject>Phone conference at 3pm</Description> 
        <Completed>false</Completed> 
        <Responsible>
          <ID>5</ID>
          <Name>Jo Bloggs</Name>
        </Responsible>
      </Activity>
    </Activities>
    <History>
      <Item>
        <Detail>Created by Jo Bloggs</Detail> 
        <Date>2008-09-12T13:00:00</Date> 
        <Staff>Jo Bloggs</Staff>
        <Type>Lead</Type>
      </Item>
      <Item>
        <Detail>A note about the lead</Detail> 
        <Date>2008-09-12T14:00:00</Date> 
        <Staff>Jo Bloggs</Staff>
        <Type>Note</Type>
      </Item>
    </History>
  </Lead>
</Response>

 

GET list

 

Parameters:

detailed=true Optional Return detailed information for lead.  See GET get/[id] method for example of detailed lead response.
from=YYYYMMDD Required Return leads created on or after this date.
to=YYYYMMDD Required Return leads created on or before this date.

 

Example URL:

GET https://api.workflowmax.com/lead.api/list?apiKey=[your API key]&accountKey=[WorkflowMax account key]&from=20090801&to=20090901

 

POST add

 

Example URL:

POST https://api.workflowmax.com/lead.api/add?apiKey=[your API key]&accountKey=[WorkflowMax account key]

 

Example Message:

<Lead>
  <Name>Brochure Design</Name>
  <Description>Detailed description of the lead</Description>
  <ClientID>123</ClientID>
  <OwnerID>5</OwnerID>    <!-- ID of staff member responsible for lead-->
  <EstimatedValue>10000</EstimatedValue>
  <ContactID>456</ContactID>    <!-- optional -->
  <CategoryID>678</CategoryID>    <!-- optional - ID of lead category-->


  <!-- ID of Lead Template to apply to lead.  Applying a template allows you to default lead activities -->
  <TemplateID>23</TemplateIDr>  <!-- optional -->   
</Lead>

 

GET categories

 

Example URL:

POST https://api.workflowmax.com/lead.api/categories?apiKey=[your API key]&accountKey=[WorkflowMax account key]

 

Example Message:

<Response>
  <Status>OK</Status> 
  <Categories>
    <Category>
      <ID>123</ID>
      <Name>Hot</Name>
    </Categoryy>
    <Category>
      <ID>124</ID>
      <Name>Cold</Name>
    </Categoryy>
  </Categories>
</Response>
  Developer API
Job Management Software developed by Xero - Copyright 2013