ByteChef LogoByteChef
Components

Insightly

Insightly is a customer relationship management (CRM) software that helps businesses manage contacts, sales, projects, and tasks in one platform.

Categories: CRM

Type: insightly/v1


Connections

Version: 1

Basic Auth

Properties

NameLabelTypeDescriptionRequired
podPodSTRINGYour instances pod can be found under your API URL, e.g. https://api.{pod}.insightly.com/v3.1true
usernameAPI KeySTRINGtrue

Actions

Create Contact

Name: createContact

Creates new contact.

Properties

NameLabelTypeDescriptionRequired
FIRST_NAMEFirst NameSTRINGThe first name of the contact.true
LAST_NAMELast NameSTRINGThe last name of the contact.false
EMAIL_ADDRESSEmail AddressSTRINGEmail address of the contact.false
PHONEPhoneSTRINGPhone number of the contact.false
TITLETitleSTRINGThe contact's title in company.false

Example JSON Structure

{
  "label" : "Create Contact",
  "name" : "createContact",
  "parameters" : {
    "FIRST_NAME" : "",
    "LAST_NAME" : "",
    "EMAIL_ADDRESS" : "",
    "PHONE" : "",
    "TITLE" : ""
  },
  "type" : "insightly/v1/createContact"
}

Output

Type: OBJECT

Properties

NameTypeDescription
CONTACT_IDINTEGERID of the contact.
FIRST_NAMESTRINGFirst name of the contact.
LAST_NAMESTRINGLast name of the contact.
EMAIL_ADDRESSSTRINGEmail address of the contact.
PHONESTRINGPhone number of the contact.
TITLESTRINGThe contact's title in company.

Output Example

{
  "CONTACT_ID" : 1,
  "FIRST_NAME" : "",
  "LAST_NAME" : "",
  "EMAIL_ADDRESS" : "",
  "PHONE" : "",
  "TITLE" : ""
}

Create Organization

Name: createOrganization

Creates new organization.

Properties

NameLabelTypeDescriptionRequired
ORGANISATION_NAMEOrganization NameSTRINGThe name of the organization.true
PHONEPhoneSTRINGA contact phone number for the organization.false
WEBSITEWebsiteSTRINGThe organization's website.false

Example JSON Structure

{
  "label" : "Create Organization",
  "name" : "createOrganization",
  "parameters" : {
    "ORGANISATION_NAME" : "",
    "PHONE" : "",
    "WEBSITE" : ""
  },
  "type" : "insightly/v1/createOrganization"
}

Output

Type: OBJECT

Properties

NameTypeDescription
ORGANISATION_IDINTEGERID of the organization.
ORGANISATION_NAMESTRINGThe name of the organization.
PHONESTRINGA contact phone number for the organization.
WEBSITESTRINGThe organization's website.

Output Example

{
  "ORGANISATION_ID" : 1,
  "ORGANISATION_NAME" : "",
  "PHONE" : "",
  "WEBSITE" : ""
}

Create Task

Name: createTask

Creates new task.

Properties

NameLabelTypeDescriptionRequired
TITLETitleSTRINGtrue
STATUSStatusSTRING
Options Not Started, In Progress, Completed, Deferred, Waiting
Task statusfalse

Example JSON Structure

{
  "label" : "Create Task",
  "name" : "createTask",
  "parameters" : {
    "TITLE" : "",
    "STATUS" : ""
  },
  "type" : "insightly/v1/createTask"
}

Output

Type: OBJECT

Properties

NameTypeDescription
TASK_IDINTEGERID of the task.
TITLESTRINGTitle of the task.
STATUSSTRINGTask status.

Output Example

{
  "TASK_ID" : 1,
  "TITLE" : "",
  "STATUS" : ""
}

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.


Additional instructions

CONNECTION

API key location