Client - Endpoints Legacy Documentation

  • GET /client/contact/$id

    • @param (int) $id - Optional
    • Return: Contact(s) Associated with API Key
  • POST /client/contact

    • @param (string) $firstname - Required
      • Match Pattern
        • [^A-Za-z0-9\-._]
    • @param (string) $lastname - Required
      • Match Pattern
        • [^A-Za-z0-9\-._]
    • @param (string) $company - Optional
      • Match Pattern
        • [^A-Za-z0-9\-._]
    • @param (string) $phone - Required
      • Match Pattern
        • @todo - Regex
    • @param (string) $email - Required
      • Match Pattern
        • Valid Email
    • @param (string) $password - Required
      • Match Pattern
        • @todo - Regex
    • @param (string) $address1 - Required
      • Match Pattern
        • [A-Za-z0-9'\.\-\s\,]
    • @param (string) $address2 - Optional
      • Match Pattern
        • [A-Za-z0-9'\.\-\s\,]
    • @param (string) $city - Required
      • Match Pattern
        • [^A-Za-z0-9\-._]
    • @param (string) $state - Required
      • Match Pattern
        • [^A-Za-z0-9\-._]
    • @param (string) $zipcode - Required
      • Match Pattern
        • [^A-Za-z0-9\-._]
    • @param (string) $county - Required
      • Match Pattern
        • 2 Character Country Code
    • Return: {"success":true,"results":1,"result":{"contactid":"CONTACT_ID"}}
  • POST /client/contactUpdate

    • @param (int) $id - Required
      • Match Pattern
        • [0-9]
    • @param (string) $firstname - Optional
      • Match Pattern
        • [^A-Za-z0-9\-._]
    • @param (string) $lastname - Optional
      • Match Pattern
        • [^A-Za-z0-9\-._]
    • @param (string) $company - Optional
      • Match Pattern
        • [^A-Za-z0-9\-._]
    • @param (string) $phone - Required
      • Match Pattern
        • [^A-Za-z0-9\-._]
    • @param (string) $email - Optional
      • Match Pattern
        • Valid Email
    • @param (string) $password - Optional
      • Match Pattern
        • @todo - Regex
    • @param (string) $address1 - Optional
      • Match Pattern
        • [A-Za-z0-9'\.\-\s\,]
    • @param (string) $address2 - Optional
      • Match Pattern
        • [A-Za-z0-9'\.\-\s\,]
    • @param (string) $city - Optional
      • Match Pattern
        • [^A-Za-z0-9\-._]
    • @param (string) $state - Optional
      • Match Pattern
        • [^A-Za-z0-9\-._]
    • @param (string) $zipcode - Optional
      • Match Pattern
        • [^A-Za-z0-9\-._]
    • @param (string) $county - Optional
      • Match Pattern
        • 2 Character Country Code
  • POST /client/contactDelete

    • @param (int) $id - Required
      • Match Pattern
        • [0-9]
      • Return: {"success":true,"results":1,"result":{"contactid":"CONTACT_ID"}}

Client - PHP Example


<?php
// Example Coming Soon...
?>