Logo
Submit a request

Customer Locations (API)

Adding a Location

URL

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

Request

<request>
    <customerLocationAdd>
        <customerId></customerId>
        <locationName></locationName>
        <isPrimary></isPrimary>
        <addressCity></addressCity>
        <addressCountry></addressCountry>
        <addressPostalCode></addressPostalCode>
        <addressState></addressState>
        <addressStreet></addressStreet>
        <locationNotes></locationNotes>
        <serviceManagerId></serviceManagerId>
        <technicianId></technicianId>
        <zone></zone>
    </customerLocationAdd>
</request>
            
  • customerId - (required) numeric, the Id of the customer to which the new location should belong
  • locationName - (required) string (50 char limit)
  • isPrimary - boolean, indicates that location should be made the "primary" location for the customer
  • addressCity - string (25 char limit)
  • addressCountry - string (25 char limit)
  • addressPostalCode - string (10 char limit)
  • addressState - string (25 char limit)
  • addressStreet - string (250 char limit)
  • locationNotes - string (1000 char limit)
  • serviceManagerId - numeric, must match an existing User Id from your user list
  • technicianId - numeric, must match an existing User Id from your user list
  • zone - string (25 char limit)

Response

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

Editing a Location

URL

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

Request

<request>
    <customerLocationEdit>
        <customerLocationId></customerLocationId>
        <locationName></locationName>
        <isPrimary></isPrimary>
        <addressCity></addressCity>
        <addressCountry></addressCountry>
        <addressPostalCode></addressPostalCode>
        <addressState></addressState>
        <addressStreet></addressStreet>
        <locationNotes></locationNotes>
        <serviceManagerId></serviceManagerId>
        <technicianId></technicianId>
        <zone></zone>
    </customerLocationEdit>
</request>
            
  • customerLocationId - (required) numeric, the Id of the location to be edited
  • locationName - string (50 char limit)
  • isPrimary - boolean, indicates that location should be made the "primary" location for the customer
  • addressCity - string (25 char limit)
  • addressCountry - string (25 char limit)
  • addressPostalCode - string (10 char limit)
  • addressState - string (25 char limit)
  • addressStreet - string (250 char limit)
  • locationNotes - string (1000 char limit)
  • serviceManagerId - numeric, must match an existing User Id from your user list
  • technicianId - numeric, must match an existing User Id from your user list
  • zone - string (25 char limit)

Response

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

Retrieving a Single Customer Location

URL

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

Request

<request>
    <customerLocationGet>
      <customerLocationId>xxxxxx</customerLocationId>
    </customerLocationGet>
</request>
            
  • customerLocationId - (required) numeric, the Id of the location to be retrieved

Response

<response status="ok">
  <customerLocation>
    <customerLocationId></customerLocationId>
    <customerId></customerId>
    <addressCity></addressCity>
    <addressCountry></addressCountry>
    <addressPostalCode></addressPostalCode>
    <addressState></addressState>
    <addressStreet></addressStreet>
    <isPrimary></isPrimary>
    <locationName></locationName>
    <locationNotes></locationNotes>
    <phone></phone>
    <primaryContactId></primaryContactId>
    <serviceManagerId></serviceManagerId>
    <technicianId></technicianId>
    <zone></zone>
  </customerLocation>
</response>
            

Deleting a Location

URL

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

Request

<request>
    <customerLocationDelete>
        <locationId>xxxxxx</locationId>
    </customerLocationDelete>
</request>
  • locationId - (required) numeric, the Id of the location to be deleted

Response

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