Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 1.33 KB

README.md

File metadata and controls

56 lines (37 loc) · 1.33 KB

Associated Contacts

Any methods return promise object.

Static methods

Retrieve deal's associated contacts

client.associatedContacts.find(dealId[, params][, callback(err, contacts)]);
  • dealId is unique identifier (number) of the deal
  • params is object with a list of filters, not required
  • callback is a function, not required

Create an associated contact

client.associatedContacts.create(dealId, data[, callback(err, contact)]);
  • dealId is unique identifier (number) of the deal
  • data is a contact object
  • callback is a function, not required

Remove an associated contact

client.associatedContacts.remove(dealId, id[, callback(err, state)]);
  • dealId is unique identifier (number) of the deal
  • id is unique identifier (number) of the contact
  • callback is a function, not required

Model methods

Remove an associated contact

contact.remove(dealId, [callback(err, state)]);
  • dealId is unique identifier (number) of the deal
  • callback is a function, not required

Detailed documentation in the official API

License

MIT

Bug Reports

Report here.