Nutshell

Nutshell CRM is a user-friendly customer relationship management software designed to help small businesses manage sales, track leads, and streamline communication.

Categories: CRM

Type: nutshell/v1

Connections

Version: 1

Basic Auth

Properties

Name	Label	Type	Description	Required
username	Email	STRING		true
password	API Key	STRING		true

Actions

Create Contact

Name: createContact

Creates new contact

Properties

Name	Label	Type	Description	Required
name	Name	STRING	Full name of the contact.	true
description	Description	STRING	Description of the contact, which appears under their name.	false
email	Email	STRING	Primary email address of the contact.	false
phone	Phone	STRING	Primary phone number of the contact	false

Example JSON Structure

{
  "label" : "Create Contact",
  "name" : "createContact",
  "parameters" : {
    "name" : "",
    "description" : "",
    "email" : "",
    "phone" : ""
  },
  "type" : "nutshell/v1/createContact"
}

Properties

Name	Type	Description
contacts	ARRAY Items [{STRING(id), STRING(type), STRING(name), STRING(description), [{BOOLEAN(isPrimary), STRING(name), STRING(value)}](emails), [{BOOLEAN(isPrimary), STRING(name), {STRING(countryCode), STRING(number), STRING(extension), STRING(numberFormatted), STRING(E164), STRING(countryCodeAndNumber)}(value)}](phones)}]

Output Example

{
  "contacts" : [ {
    "id" : "",
    "type" : "",
    "name" : "",
    "description" : "",
    "emails" : [ {
      "isPrimary" : false,
      "name" : "",
      "value" : ""
    } ],
    "phones" : [ {
      "isPrimary" : false,
      "name" : "",
      "value" : {
        "countryCode" : "",
        "number" : "",
        "extension" : "",
        "numberFormatted" : "",
        "E164" : "",
        "countryCodeAndNumber" : ""
      }
    } ]
  } ]
}

Create Company

Name: createCompany

Creates new company

Properties

Name	Label	Type	Description	Required
name	Name	STRING	Full name of the company.	true
description	Description	STRING	Detailed Description of the company.	false
email	Email	STRING	Primary email address of the company.	false
phone	Phone	STRING	Primary phone number of the company	false

Example JSON Structure

{
  "label" : "Create Company",
  "name" : "createCompany",
  "parameters" : {
    "name" : "",
    "description" : "",
    "email" : "",
    "phone" : ""
  },
  "type" : "nutshell/v1/createCompany"
}

Properties

Name	Type	Description
accounts	ARRAY Items [{STRING(id), STRING(type), STRING(name), STRING(description), [{BOOLEAN(isPrimary), STRING(name), STRING(value)}](emails), [{BOOLEAN(isPrimary), STRING(name), {STRING(countryCode), STRING(number), STRING(extension), STRING(numberFormatted), STRING(E164), STRING(countryCodeAndNumber)}(value)}](phones)}]

Output Example

{
  "accounts" : [ {
    "id" : "",
    "type" : "",
    "name" : "",
    "description" : "",
    "emails" : [ {
      "isPrimary" : false,
      "name" : "",
      "value" : ""
    } ],
    "phones" : [ {
      "isPrimary" : false,
      "name" : "",
      "value" : {
        "countryCode" : "",
        "number" : "",
        "extension" : "",
        "numberFormatted" : "",
        "E164" : "",
        "countryCodeAndNumber" : ""
      }
    } ]
  } ]
}

Create Lead

Name: createLead

Creates new Lead

Properties

Name	Label	Type	Description	Required
description	Name	Description	STRING	Description of the lead, which is also set as the name of the lead
owner	Assignee	STRING	The user to whom the lead is assigned	false

Example JSON Structure

{
  "label" : "Create Lead",
  "name" : "createLead",
  "parameters" : {
    "description" : "",
    "owner" : ""
  },
  "type" : "nutshell/v1/createLead"
}

Properties

Name	Type	Description
leads	ARRAY Items [{STRING(id), STRING(type), STRING(name), STRING(description)}]

Output Example

{
  "leads" : [ {
    "id" : "",
    "type" : "",
    "name" : "",
    "description" : ""
  } ]
}

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.

On this page