Customer Information API
      Back to home
      1. Help Center
      2. API
      3. Customer Information API

      Contact API

      Create Contact
      URL /Contact/Create
      Method POST
      Body

      [
      {
      "CustomerId":383,
      "Phone":"1231230011",
      "MobilePhone":"1231230011",
      "Fax":"1231230011",
      "FirstName":"first name",
      "LastName":"last name",
      "NotifyViaEmail":true,
      "NotifyViaSms":true,
      "Email":"examplemail@gmail.com",
      "CarrierId":5,
      "ContactTypeId":21
      }
      ]
      Response
      HTTP/1.1 400 Error Message
      HTTP/1.1 200 OK
       [
         {
            "CarrierId":5,
            "ContactTypeId":21,
            "CustomerId":383,
            "Email":"examplemail@gmail.com",
            "Fax":"1231230011",
            "FirstName":"first name",
            "Id":298,
            "LastName":"last name",
            "MobilePhone":"1231230011",
            "NotifyViaEmail":true,
            "NotifyViaSms":true,
            "Phone":"1231230011",
            "LastChangeDate":"\/Date(1484935903529)\/"
         }
      ]
      Comments

       
        Update Contact
      URL /Contact
      Method PUT
      Body

      {
      "Id":298,
      "CustomerId":383,
      "Phone":"1231230011",
      "MobilePhone":"1231230011",
      "Fax":"1231230011",
      "FirstName":"first name",
      "LastName":"last name",
      "NotifyViaEmail":true,
      "NotifyViaSms":true,
      "Email":"examplemail@gmail.com",
      "CarrierId":5,
      "ContactTypeId":21
      }
      Response
      HTTP/1.1 400 Business rule violation. Full Name is Required; Phone or Mobile Phone are Required
      HTTP/1.1 200 OK
      {
         "CarrierId":5,
         "ContactTypeId":21,
         "CustomerId":383,
         "Email":"examplemail@gmail.com",
         "Fax":"1231230011",
         "FirstName":"first name",
         "Id":299,
         "LastName":"last name",
         "MobilePhone":"1231230011",
         "NotifyViaEmail":true,
         "NotifyViaSms":true,
         "Phone":"1231230011",
         "LastChangeDate":"\/Date(1484935903529)\/"
      }
      Comments

       
        Delete Contact
      URL /Contact/{id}
      Method DELETE
      Body

       
      Response
      HTTP/1.1 400 Entity with 386 id not found
      HTTP/1.1 200 OK
      Comments

       
        Get Contacts
      URL /Contact/List/{customerId}
      Method GET
      Body

       
      Response

      [
         {
            "CarrierId":5,
            "ContactTypeId":21,
            "CustomerId":383,
            "Email":"examplemail@gmail.com",
            "Fax":"1231230011",
            "FirstName":"first name",
            "Id":302,
            "LastName":"last name",
            "MobilePhone":"1231230011",
            "NotifyViaEmail":true,
            "NotifyViaSms":true,
            "Phone":"1231230011",

            "LastChangeDate":"\/Date(1484935903529)\/"
         }
      ]
      Comments

       
        Get Contact
      URL /Contact/{id}
      Method GET
      Body

       
      Response

      {
            "CarrierId":5,
            "ContactTypeId":21,
            "CustomerId":383,
            "Email":"examplemail@gmail.com",
            "Fax":"1231230011",
            "FirstName":"first name",
            "Id":302,
            "LastName":"last name",
            "MobilePhone":"1231230011",
            "NotifyViaEmail":true,
            "NotifyViaSms":true,
            "Phone":"1231230011",

            "LastChangeDate":"/Date(1461233532086)/"
      }
      Comments