Client Methods

GET list	Return a list of all clients
GET get/[id]	Detailed information for a specific client
POST add	Add a client and contacts
PUT update	Update a clients details
PUT archive	Archive a client
POST delete	Delete a client
GET contact/[id]	Detailed information for a specific contact
PUT contact/[id]	Update a contacts details
POST contact	add a contact to a client

GET list

Parameters:

detailed=true

Optional

Return detailed information of client. See GET get/[id] method for example of detailed client response.

Example URL:

http://api.workflowmax.com/client.api/list?apiKey=[your API key]&accountKey=[WorkflowMax account key]

Example Response:

<Response>
  <Status>OK</Status> 
  <Clients>
    <Client>
      <ID>255</ID> 
      <Name>XYZ Australia, NZ Business Unit</Name> 
      <Address /> 
      <PostalAddress>XYZ Australia Level 32, PWC Building 
         188 Quay Street
         Auckland Central Auckland
      </PostalAddress> 
      <Phone /> 
      <Fax /> 
      <Website /> 
      <ReferralSource />
      <ExportCode />
      <IsProspect>No</IsProspect> 
      <Contacts>
        <Contact>
          <ID>220</ID> 
          <Name>Samantha Benecke</Name> 
          <Mobile /> 
          <Email /> 
          <Phone /> 
          <Position /> 
        </Contact>
      </Contacts>
    </Client>
    <Client>
      <ID>697</ID> 
      <Name>A. Dutchess</Name> 
      <Address /> 
      <PostalAddress>P O Box 123 Wellington 6011</PostalAddress> 
      <Phone /> 
      <Fax /> 
      <Website /> 
      <Contacts /> 
    </Client>
  </Clients>
</Response>

GET get/[id]

Example URL:

http://api.workflowmax.com/client.api/get/123?apiKey=[your API key]&accountKey=[WorkflowMax account key]

Example Response:

<Response>
  <Status>OK</Status> 
  <Client>
    <ID>218</ID> 
    <Name>Acmer Pty Ltd</Name> 
    <Address /> 
    <PostalAddress>Acmer Pty Ltd 
       412 Alice Spring Road 
       Greenacres "Sydney, NSW 2164"
    </PostalAddress> 
    <Phone>(02) 1723 5265</Phone> 
    <Fax /> 
    <Website /> 
    <ReferralSource />
    <ExportCode />
    <IsProspect>No</IsProspect> 
    <Contacts>
      <Contact>
        <ID>193</ID> 
        <Name>Wyett E Coyote</Name> 
        <Mobile /> 
        <Email /> 
        <Phone /> 
        <Position /> 
      </Contact>
    </Contacts>
    <Notes>
      <Note>
        <Title>note title</Title> 
        <Text>subject of the note</Text> 
        <Folder /> 
        <Date>2008-09-12T13:00:00</Date> 
        <CreatedBy>Jo Bloggs</CreatedBy>
      </Note>
    </Notes>
  </Client>
</Response>

POST add

Example URL:

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

Example Message:

 
<Client>
  <Name>Bloggs Electrical Ltd</Name>
  <Address></Address>  <!-- optional -->   
  <PostalAddress></PostalAddress>  <!-- optional -->   
  <Phone></Phone>  <!-- optional -->   
  <Fax></Fax>  <!-- optional -->   
  <WebSite></WebSite>  <!-- optional -->   
  <ReferralSource></ReferralSource>  <!-- optional -->   
  <ExportCode></ExportCode>  <!-- optional --> 
  <IsProspect>No</IsProspect>    <!-- Yes | No --> 
  <Contacts>
    <Contact>
      <Name>Jo Bloggs</Name>   
      <Phone></Phone>  <!-- optional -->   
      <Mobile></Mobile>  <!-- optional -->   
      <Email></Email>  <!-- optional -->   
      <Position></Position>  <!-- optional -->   
    </Contact>
  </Contacts>
</Client>

The response will include the detailed information of the client as per the GET get/[id] method

PUT update

Example URL:

PUT http://api.workflowmax.com/client.api/update?apiKey=[your API key]&accountKey=[WorkflowMax account key]

Example Message:

 
<Client>
  <ID>1234</ID>
  <Name>Bloggs Electrical Ltd</Name>
  <Address></Address>  <!-- optional -->   
  <PostalAddress></PostalAddress>  <!-- optional -->   
  <Phone></Phone>  <!-- optional -->   
  <Fax></Fax>  <!-- optional -->   
  <WebSite></WebSite>  <!-- optional -->   
  <ReferralSourcee></ReferralSource>  <!-- optional -->   
</Client>

The response will include the detailed information of the client as per the GET get/[id] method

PUT archive

Example URL:

PUT http://api.workflowmax.com/client.api/archive?apiKey=[your API key]&accountKey=[WorkflowMax account key]

Example Message:

 
<Client>
  <ID>1234</ID>
</Client>

The response will include the detailed information of the client as per the GET get/[id] method

POST delete

Example URL:

POST http://api.workflowmax.com/client.api/delete?apiKey=[your API key]&accountKey=[WorkflowMax account key]

Example Message:

 
<Client>
  <ID>1234</ID>
</Client>

GET contact/[id]

Example URL:

http://api.workflowmax.com/client.api/contact/123?apiKey=[your API key]&accountKey=[WorkflowMax account key]

Example Response:

<Response>
  <Status>OK</Status> 
  <Contact>
    <ID>123</ID> 
    <Name>Wyett E Coyote</Name> 
    <Mobile /> 
    <Email /> 
    <Phone /> 
    <Position /> 
  </Contact>
</Response>

PUT contact/[id]

Example URL:

PUT http://api.workflowmax.com/client.api/contact/123?apiKey=[your API key]&accountKey=[WorkflowMax account key]

Example Message:

 
<Contact>
  <Name>Wyett E Coyote</Name> 
  <Mobile /> 
  <Email /> 
  <Phone /> 
  <Position /> 
</Contact>

The response will include the detailed information of the contact as per the GET contact/[id] method

POST contact

Example URL:

POST http://api.workflowmax.com/client.api/contact?apiKey=[your API key]&accountKey=[WorkflowMax account key]

Example Message:

 
<Contact>
  <Client>
    <ID>142</ID> 
  </Client>
  <Name>Wyett E Coyote</Name> 
  <Mobile /> 
  <Email /> 
  <Phone /> 
  <Position /> 
</Contact>

The response will include the detailed information of the contact as per the GET contact/[id] method

Developer API