CustomerContact – Developer Support

About CustomerContact

When a Customer is created, only one contact can be entered. The customer's organization usually has multiple individual contacts (for example, Purchasing, Sales, Accounting, and more).

When an invoice or public note is emailed, one or more contact can be selected to receive the communication.

Create

Request

<API_URL_EndPoint>/Crud/Create/CustomerContact.json

data={
  "obj" : {
    "entity" : "CustomerContact",
    "isActive" : "1",
    "customerId" : "0cu01QRJUQPTKMMYijuo",
    "firstName" : "George",
    "lastName" : "Smith",
    "email" : "gmsith@com.com",
    "phone" : "123-123-1234",
    "altPhone" : "123-123-2345",
    "fax" : "123-1123-1235",
    "timezoneId" : "3"
  }
}

Response

{
  "response_status" : 0,
  "response_message" : "Success",
  "response_data" : {
    "entity" : "CustomerContact",
    "id" : "cpu01LIXIUYOBWBQ296p",
    "isActive" : "1",
    "createdTime" : "2016-12-09T23:29:51.000+0000",
    "updatedTime" : "2016-12-09T23:29:51.000+0000",
    "customerId" : "0cu01QRJUQPTKMMYijuo",
    "firstName" : "George",
    "lastName" : "Smith",
    "email" : "gmsith@com.com",
    "phone" : "123-123-1234",
    "altPhone" : "123-123-2345",
    "fax" : "123-1123-1235",
    "timezoneId" : "3"
  }
}

Read

Request

<API_URL_EndPoint>/Crud/Read/CustomerContact.json

data={
   "id" : "cpu01LIXIUYOBWBQ296p"
}

Response

{
  "response_status" : 0,
  "response_message" : "Success",
  "response_data" : {
    "entity" : "CustomerContact",
    "id" : "cpu01LIXIUYOBWBQ296p",
    "isActive" : "1",
    "createdTime" : "2016-12-09T23:29:51.000+0000",
    "updatedTime" : "2016-12-09T23:29:51.000+0000",
    "customerId" : "0cu01QRJUQPTKMMYijuo",
    "firstName" : "George",
    "lastName" : "Smith",
    "email" : "gmsith@com.com",
    "phone" : "123-123-1234",
    "altPhone" : "123-123-2345",
    "fax" : "123-1123-1235",
    "timezoneId" : "3"
  }
}

Update

Request

<API_URL_EndPoint>/Crud/Update/CustomerContact.json

data={
   "obj" : {
    "entity" : "CustomerContact",
    "id" : "cpu01LIXIUYOBWBQ296p",
    "isActive" : "1",
    "createdTime" : "2016-12-09T23:29:51.000+0000",
    "updatedTime" : "2016-12-09T23:29:51.000+0000",
    "customerId" : "0cu01QRJUQPTKMMYijuo",
    "firstName" : "George",
    "lastName" : "Smith",
    "email" : "gmsith@com.com",
    "phone" : "123-123-3456",
    "altPhone" : "123-123-2345",
    "fax" : "123-1123-7777",
    "timezoneId" : "3"
   }
}

Response

{
  "response_status" : 0,
  "response_message" : "Success",
  "response_data" : {
    "entity" : "CustomerContact",
    "id" : "cpu01LIXIUYOBWBQ296p",
    "isActive" : "1",
    "createdTime" : "2016-12-09T23:29:51.000+0000",
    "updatedTime" : "2016-12-09T23:36:44.000+0000",
    "customerId" : "0cu01QRJUQPTKMMYijuo",
    "firstName" : "George",
    "lastName" : "Smith",
    "email" : "gmsith@com.com",
    "phone" : "123-123-3456",
    "altPhone" : "123-123-2345",
    "fax" : "123-1123-7777",
    "timezoneId" : "3"
  }
}

Delete

Request

<API_URL_EndPoint>/Crud/Delete/CustomerContact.json

data={
   "id" : "cpu01LIXIUYOBWBQ296p"
}

Response

{
  "response_status" : 0,
  "response_message" : "Success",
  "response_data" : {
    "entity" : "CustomerContact",
    "id" : "cpu01LIXIUYOBWBQ296p",
    "isActive" : "2",
    "createdTime" : "2016-12-09T23:29:51.000+0000",
    "updatedTime" : "2016-12-09T23:33:19.000+0000",
    "customerId" : "0cu01QRJUQPTKMMYijuo",
    "firstName" : "George",
    "lastName" : "Smith",
    "email" : "gmsith@com.com",
    "phone" : "123-123-1234",
    "altPhone" : "123-123-2345",
    "fax" : "123-1123-1235",
    "timezoneId" : "3"
  }
}

Undelete

Request

<API_URL_EndPoint>/Crud/Undelete/CustomerContact.json

data={
   "id" : "cpu01LIXIUYOBWBQ296p"
}

Response

{
  "response_status" : 0,
  "response_message" : "Success",
  "response_data" : {
    "entity" : "CustomerContact",
    "id" : "cpu01LIXIUYOBWBQ296p",
    "isActive" : "1",
    "createdTime" : "2016-12-09T23:29:51.000+0000",
    "updatedTime" : "2016-12-09T23:33:19.000+0000",
    "customerId" : "0cu01QRJUQPTKMMYijuo",
    "firstName" : "George",
    "lastName" : "Smith",
    "email" : "gmsith@com.com",
    "phone" : "123-123-1234",
    "altPhone" : "123-123-2345",
    "fax" : "123-1123-1235",
    "timezoneId" : "3"
  }
}

Resources

Parameters

Field Name	Description	Required?
customerId	The system generated ID of the customer.	Yes
isActive	Denotes if the customer is active [value="1"] or inactive [value="2"].	No
firstName	First name of the contact.	Yes
lastName	Last name of the contact.	No
email	Email of the contact.	Yes
phone	Phone number of the contact.	No
altPhone	Alternative phone number of the contact.	No
fax	Fax number of the contact.	No
timezoneId	The time zone of the contact (PST [value="3"], MST [value="4"], CST [value="5"], EST [value="6"]).	Yes