Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

Use this method to add a new contact to an existing Customer in Komet Sales.

Tip

Valid Tokens: Company.


Filter by label (Content by label)
showLabelsfalse
max5
sorttitle
titleRelated Articles
cqllabel in ( "company-token" , "customer-contact" , "api" , "tokens-api" , "customer-account" , "contact-list" )

Request


URL: https://api.kometsales.com/api/customer.contact.add

Method: POST

Content-Type: application/JSON


Input Parameters

authenticationToken (required)(string:50)

Komet Sales security token.


customerId (required) (integer:20)

The Customer ID.

You can get this value from the customer.list API method.


name (required)(string:200)

Contact’s name.


type (required)(string:200)

Contact type. You must send a contact-type that is already registered in the system. 

For example: A/P, Buyer, etc.


phone (optional)(string:200)

Contact’s phone number.


ext (optional)(string:50)

The extension number of the contact.


mobile (optional)(string:50)

The contact’s mobile phone number.


fax (optional)(string:50)

Contact’s fax number.


email (optional)(string:50)

The contact’s e-mail address.


description (optional)(string:200)

The contact’s additional information. 


instantMessaging (optional)(string:200)

Instant messaging number. 


emailPOD (optional)(boolean)

Choose if the contact should receive PODs. 


Code Block
{
    "authenticationToken": "token_info_goes_here", 
    "customerId":6326, 
    "name": "Joe Smith",
    "type": "Buyer",
    "phone": "594-123-0982",
    "ext": "345",
    "mobile": "305-0112-0982",
    "fax": "594-123-0112",
    "email": "contact@mydomain.com",
    "description": "nothing special",
    "instantMessaging": "594-123-0982",
    "emailPOD": false
  }

Response


status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure


message (string:500)

Transaction status description.


contactId (integer:20)

Internal Contact ID that was just added.


Code Block
{
  "status": 1,
  "message": "Contact was successfully saved",
  "contactId": 4535434
 }
We've encountered an issue exporting this macro. Please try exporting this page again later.