Logo
Submit a request

Customer Contacts (API)

Adding a Contact

URL

https://app.bluefolder.com/api/2.0/customers/addContact.aspx

Request

<request>
    <customerContactAdd>
        <customerId></customerId>
        <firstName></firstName>
        <lastName></lastName>
        <isPrimary></isPrimary>
        <email></email>
        <jobTitle></jobTitle>
        <notes></notes>
        <phone></phone>
        <phoneFax></phoneFax>
        <phoneHome></phoneHome>
        <phoneMobile></phoneMobile>
        <phoneOther></phoneOther>
        <title></title>
    </customerContactAdd>
</request>
            
  • customerId - (required) numeric, the Id of the customer to which the new contact should belong
  • firstName - (required) string (25 char limit)
  • lastName - (required) string (25 char limit)
  • NOTE: firstName OR lastName is required, not both
  • isPrimary - boolean, indicates that contact should be made the "primary" contact for the customer
  • email - string (100 char limit)
  • jobTitle - string (50 char limit)
  • notes - string (1000 char limit)
  • phone - string (30 char limit)
  • phoneFax - string (30 char limit)
  • phoneHome - string (30 char limit)
  • phoneMobile - string (30 char limit)
  • phoneOther - string (30 char limit)
  • title - string (10 char limit)

Response

<response status="ok">
    <customerContactId>xxxxxx</customerContactId>
</response>
            

Editing a Contact

URL

https://app.bluefolder.com/api/2.0/customers/editContact.aspx

Request

<request>
    <customerContactEdit>
        <customerContactId></customerContactId>
        <firstName></firstName>
        <lastName></lastName>
        <inactive></inactive>
        <isPrimary></isPrimary>
        <email></email>
        <jobTitle></jobTitle>
        <notes></notes>
        <phone></phone>
        <phoneFax></phoneFax>
        <phoneHome></phoneHome>
        <phoneMobile></phoneMobile>
        <phoneOther></phoneOther>
        <title></title>
    </customerContactEdit>
</request>
            
  • customerContactId - (required) numeric, the Id of the contact to be edited
  • firstName - string (25 char limit)
  • lastName - string (25 char limit)
  • inactive - boolean, indicates that the contact should be marked inactive or not
  • isPrimary - boolean, indicates that contact should be made the "primary" contact for the customer
  • email - string (100 char limit)
  • jobTitle - string (50 char limit)
  • notes - string (1000 char limit)
  • phone - string (30 char limit)
  • phoneFax - string (30 char limit)
  • phoneHome - string (30 char limit)
  • phoneMobile - string (30 char limit)
  • phoneOther - string (30 char limit)
  • title - string (10 char limit)

Response

<response status="ok">
    <customerContactId>xxxxxx</customerContactId>
</response>
            

Retrieving a Single Customer Contact

URL

https://app.bluefolder.com/api/2.0/customers/getContact.aspx

Request

<request>
    <customerContactGet>
      <customerContactId>xxxxxx</customerContactId>
    </customerContactGet>
</request>
            
  • customerContactId - (required) numeric, the Id of the contact to be retrieved

Response

<response status="ok">
  <customerContact>
    <customerContactId></customerContactId>
    <customerId></customerId>
    <email></email>
    <firstName></firstName>
    <inactive></inactive>
    <isPrimary></isPrimary>
    <jobTitle></jobTitle>
    <lastName></lastName>
    <customerLocationId></customerLocationId>
    <middleName></middleName>
    <notes></notes>
    <phone></phone>
    <phoneFax></phoneFax>
    <phoneHome></phoneHome>
    <phoneMobile></phoneMobile>
    <phoneOther></phoneOther>
    <title></title>
  </customerContact>
</response>
            

Deleting a Contact

URL

https://app.bluefolder.com/api/2.0/customers/deleteContact.aspx

Request

<request>
    <customerContactDelete>
        <contactId>xxxxxx</contactId>
    </customerContactDelete>
</request>
  • contactId - (required) numeric, the Id of the contact to be deleted

Response

<?xml version="1.0" ?>
<response status='ok'>
    <contactId></contactId>
</response>
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request