API Documentation

Lead Methods

Method	Description
GET current	Returns a list of current leads
GET get/[uuid]	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

Returns a list of current leads

Parameters

Parameter	Required?	Description
detailed=true	Optional	Return detailed information for lead. See GET get/[identifier] method for example of detailed lead response.

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/lead.api/current

Example Response

<Response>
  <Status>OK</Status>
  <Leads>
    <Lead>
      <UUID>0c6c8518-b2f2-4d2e-86d5-4cda1ffad545</UUID>
      <Name>Brochure Design</Name>
      <Description />
      <State>Current</State>
      <EstimatedValue>10000</EstimatedValue>
      <Date>2008-08-29T00:00:00</Date> 
      <DateWonLost />
      <Category>Hot</Category> 
      <Dropbox>lead+dropbox+example@emailmyjob.com</Dropbox>
      <Client>
        <UUID>23a720b6-a58e-4c4f-a938-bddbea7b4c66</UUID>
        <Name>A C Smith Limited</Name>
      </Client>
      <Contact>
        <UUID>9f286b6c-9db8-472d-adf0-e1595f2a80b5</UUID>
        <Name>Andrew Smith</Name>
      </Contact>
      <Owner>
        <UUID>44ce9043-8a05-45e6-9a6b-93a7458d5734</UUID>
        <Name>Jo Bloggs</Name>
      </Owner>
    </Lead>
  </Leads>
</Response>

GET get/[uuid]

Detailed information for a specific lead

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/lead.api/get/0c6c8518-b2f2-4d2e-86d5-4cda1ffad545

Example Response

<Response>
  <Status>OK</Status> 
  <Lead>
    <UUID>0c6c8518-b2f2-4d2e-86d5-4cda1ffad545</UUID>
    <Name>Brochure Design</Name>
    <Description />
    <State>Current</State>
    <EstimatedValue>10000</EstimatedValue>
    <Date>2008-08-29T00:00:00</Date> 
    <DateWonLost />
    <Category>Hot</Category> 
    <Client>
      <UUID>23a720b6-a58e-4c4f-a938-bddbea7b4c66</UUID>
      <Name>A C Smith Limited</Name>
    </Client>
    <Contact>
      <UUID>9f286b6c-9db8-472d-adf0-e1595f2a80b5</UUID>
      <Name>Andrew Smith</Name>
    </Contact>
    <Owner>
      <UUID>44ce9043-8a05-45e6-9a6b-93a7458d5734</UUID>
      <Name>Jo Bloggs</Name>
    </Owner>
    <Activities>
      <Activity>
        <Date>2008-09-24T00:00:00</Date> 
        <Subject>Phone conference at 3pm</Description> 
        <Completed>false</Completed> 
        <Responsible>
          <UUID>44ce9043-8a05-45e6-9a6b-93a7458d5734</UUID>
          <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

Return a list of all leads

Parameters

Parameter	Required?	Description
from=YYYYMMDD	Required	Return leads created on or after this date.

to=YYYYMMDD	Required	Return leads created on or before this date.

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

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/lead.api/list?from=20090801&to=20090901

POST add

Add a lead

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/lead.api/add

Example Message

<Lead>
  <Name>Brochure Design</Name>
  <Description>Detailed description of the lead</Description>
  <ClientUUID>11d2b1dc-32cd-411d-b8b2-9d6c02517b8f</ClientUUID>
  <OwnerUUID>44ce9043-8a05-45e6-9a6b-93a7458d5734</OwnerUUID>    <!-- UUID of staff member responsible for lead-->
  <EstimatedValue>10000</EstimatedValue>
  <ContactUUID>e3f6de9d-455b-4f98-980c-72785ebeb008</ContactUUID>    <!-- optional -->
  <CategoryUUID>1404fb3b-ed04-4513-9c60-16955d5de540</CategoryUUID>    <!-- optional - UUID of lead category-->


  <!-- ID of Lead Template to apply to lead.  Applying a template allows you to default lead activities -->
  <TemplateUUID>c616f5d2-d492-445d-995c-f57cf4d6c12d</TemplateUUID>  <!-- optional -->
</Lead>

GET categories

Return a list of lead categories

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/lead.api/categories

Example Message

<Response>
  <Status>OK</Status> 
  <Categories>
    <Category>
      <UUID>123123ff-642a-4448-2379-bbb7d81c1ab2</UUID>
      <Name>Cool</Name>
    </Category>
    <Category>
      <UUID>d7dc3b97-7980-4448-9732-aaa5d81c1cf3</UUID>
      <Name>Uncool</Name>
    </Category>
  </Categories>
</Response>