Insightly

Overview

Events

• Contact Updated

  Triggers a Flow when a contact is updated.

  Options

  • Channel (drop down menu): The channel you wish to trigger the Flow when the event occurs within it.

  Output Fields

  • Contact
    • Contact ID (text): Unique identifier of the contact to update. This can be dragged from the create contact card, or by using ‘Search Contacts’.
    • Salutation (text):  Mr/Mrs/etc.
    • First Name (text): User’s first name.
    • Last Name (text): User’s last name.
    • Work Email (list of text): User’s email.
    • Work Phone (list of text): User’s work phone.
    • Mobile Phone (list of text): User’s mobile phone.
    • Work Website (list of text): User’s work website.
    • Background (text): Additional background notes, bio, etc.
    • Image URL (text): URL of contact image.
    • Default Linked Organization (text): Select an organization defined in the Links field to be marked as default. If empty, or is not included in Links, or is not a valid ORGANISATION_ID, the first organization link will be set as default.
    • Owner User ID (text): User ID of the Contact Owner.
    • Date Created (text): Date the contact was created.
    • Date Updated (text): Date the contact was updated.
    • Visible To (text): This field can have one of the following values: ‘Everyone’ (Default), ‘Owner’, ‘Team’, or ‘Individuals’.
    • Visible Team ID (text): If VISIBLE_TO is ‘Team’, then this should be a Team ID, which must be a valid TEAM_ID record locator.
    • Visible User IDs (text): If VISIBLE_TO is ‘Individuals’, then this should be a comma-separated list of User IDs. This field is always empty in the response. Upon successful POST or PUT an anonymous team is created from the list of IDs, and the response will contain a VISIBLE_TEAM_ID.
    • Tags (list of text): Set of Tags attached to the Contact.
    • Address (object):
      • Address ID (number): Unique identifier of the address.
      • Address Type (text): ADDRESS_TYPE must be one of the following values: ‘Postal’, ‘Work’, ‘Primary’, ‘Home’ or ‘Other’. ‘Postal’, ‘Work’ and ‘Primary’ map to the Mailing Address and ‘Home’ and ‘Other’ map to the Other Address.
      • Street (text): Street Number and Name of Address.
      • City (text): City.
      • State (text): State/Province.
      • Postcode (text): Zip or Postal Code.
      • Country (text): Country.
  • Custom fields
    • Contact Custom Field (text): Customizable field for contact.
  • context 
    • Execution ID (text): Identifier of Execution.

  Output Fields

  • Contact
    • Date Updated (text): Date the contact was updated.

• Lead Updated

  Triggers the Flow when a lead is updated in Insightly.

  Options

  • Channel (drop down menu): The channel which will trigger the Flow if a lead is updated within it.

  Output Fields

  • Lead

    • Lead ID (text): ID of the Lead.

    • Salutation (text): Salutation (Mr/Mrs/etc).

    • Title (text): Title (Principal/CFO/CEO).

    • First Name (text): First/Given Name.

    • Last Name (text): Last/Family/Surname of the Lead.

    • Organization Name (text): Organization Name.

    • Phone Number (text): Phone Number.

    • Mobile Phone Number (text): Mobile Number.

    • Fax Number (text): Fax Number

    • Email Address (text): Email Address

    • Website URL (text): Website URL Address.

    • Owner User ID (text): User ID of the Lead Owner.

    • Date Created (text): Creation Date of the Opportunity, in YYYY-MM-DD format.

    • Date Updated (text): Updated Date of the Opportunity, in YYYY-MM-DD format.

    • Converted (T/F): Date and time Lead record updated, as Coordinated Universal Time (read only, automatically generated by server)

    • Converted Date (text): Date and time Lead record converted to opportunity, as Coordinated Universal Time (read only, automatically generated by server)

    • Converted Contact ID (integers): The Contact ID resulted from a Lead conversion process to Opportunity

    • Converted Organization ID (integers): The Organization ID resulted from a Lead conversion process to Opportunity

    • Converted Opportunity ID (integers): The Opportunity ID resulted from a Lead conversion process

    • Visible To (text): This field can have one of the following values: ‘Everyone’ (Default), ‘Owner’, ‘Team’, or ‘Individuals’.

    • Responsible User ID (text): Responsible User’s ID.

    • Industry (text): The associated Industry

    • Lead Status ID  (number): Lead Statuses which will be having a value pair of (status and status type).

    • Lead Source ID  (number): Lead Source i.e. web, phone etc.

    • Employee Count (text): Employee count for the lead’s organization

    • Lead Rating  (number): Lead’s Rating

    • Lead Description  (text): Lead’s Description

    • Visible Team ID  (number): If VISIBLE_TO is ‘Team’, then this should be a Team ID, which must be a valid TEAM_ID record locator.

    • Visible User IDs (number): If VISIBLE_TO is ‘Individuals’, then this should be a comma-separated list of User IDs. This field is always empty in the response. Upon successful POST or PUT an anonymous team is created from the list of IDs, and the response will contain a VISIBLE_TEAM_ID.

    • Tags (list of text): Set of Tags attached to the Lead.

  • Address 

    • Street (text): Street Number and Name of Address.
    • City (text): City.
    • State (text): State/Province.
    • Postcode (text): Zip or Postal Code.
    • Country (text): Country.

  • Custom Fields1

    • Lead Custom Field _(text): C_ustomizable field for the lead.

  • context

    • Execution ID (text): Unique identifier of execution of the Flow.

• New Contact

  Triggers a Flow when a new contact is created in Insightly.

  Options

  • Channel (text): The channel to create a new contact in.

  Output Fields

  • Contact
    • Contact ID (text):  ID of the Contact.
    • Salutation (text):  Mr/Mrs/etc.
    • First Name (text): User’s first name.
    • Last Name (text): User’s last name.
    • Work Email (list of text): User’s email.
    • Work Phone (list of text): User’s work phone.
    • Mobile Phone (list of text): User’s mobile phone.
    • Work Website (list of text): User’s work website.
    • Background (text): Additional background notes, bio, etc.
    • Image URL (text): The URL of the contact’s profile image.
    • Default Linked Organization (text): Select an organization defined in the Links field to be marked as default. If empty, or is not included in Links, or is not a valid ORGANISATION_ID, the first organization link will be set as default.
    • Owner User ID (text): User ID of the Contact Owner.
    • Date Created (text): Date the contact was created.
    • Date Updated (text): Date the contact was updated.
    • Visible To (text): This field can have one of the following values: ‘Everyone’ (Default), ‘Owner’, ‘Team’, or ‘Individuals’.
    • Visible Team ID (text): If VISIBLE_TO is ‘Team’, then this should be a Team ID, which must be a valid TEAM_ID record locator.
    • Visible User IDs (text): If VISIBLE_TO is ‘Individuals’, then this should be a comma-separated list of User IDs. This field is always empty in the response. Upon successful POST or PUT an anonymous team is created from the list of IDs, and the response will contain a VISIBLE_TEAM_ID.
    • Tags (list of text): Set of Tags attached to the Contact.
  • Address
    • Address ID (text): Unique identifier of the address.
    • Address Type (text): ADDRESS_TYPE must be one of the following values: ‘Postal’, ‘Work’, ‘Primary’, ‘Home’ or ‘Other’. ‘Postal’, ‘Work’ and ‘Primary’ map to the Mailing Address and ‘Home’ and ‘Other’ map to the Other Address.
    • Street (text): Street Number and Name of Address.
    • City (text): City.
    • State (text): State/Province.
    • Postcode (text): Zip or Postal Code.
    • Country (text): Country.
  • Custom fields
    • Contact Custom Field (text): Customizable field for contact.
  • Context 
    • Execution ID (text): Unique ID of execution of the Flow.

• New Lead

  Triggers a Flow when a new lead is created in Insightly.

  Options

  • Channel (drop down menu): The channel which will trigger the Flow if a lead is updated within it.

  Output Fields

  • Lead
    • Lead ID (text): The ID of the lead.
    • Salutation (text): Salutation (Mr/Mrs/etc).
    • Title (text): Title (Principal/CFO/CEO).
    • First Name (text): First/Given Name.
    • Last Name (text): Last/Family/Surname of the Lead.
    • Organization Name (text): Organization Name.
    • Phone Number (text): Phone Number.
    • Mobile Phone Number (text): Mobile Number.
    • Fax Number (text): Fax Number
    • Email Address (text): Email Address
    • Website URL (text): Website URL Address.
    • Owner User ID (text): User ID of the Lead Owner.
    • Date Created (text): Creation Date of the Opportunity, in YYYY-MM-DD format.
    • Date Updated (text): Updated Date of the Opportunity, in YYYY-MM-DD format.
    • Converted (T/F): Date and time Lead record updated, as Coordinated Universal Time (read only, automatically generated by server)
    • Converted Date(text): Date and time Lead record converted to opportunity, as Coordinated Universal Time (read only, automatically generated by server)
    • Converted Contact ID (integers): The Contact ID resulted from a Lead conversion process to Opportunity
    • Converted Organization ID (integers): The Organization ID resulted from a Lead conversion process to Opportunity
    • Converted Opportunity ID (integers): The Opportunity ID resulted from a Lead conversion process
    • Visible To (text): This field can have one of the following values: ‘Everyone’ (Default), ‘Owner’, ‘Team’, or ‘Individuals’.
    • Responsible User ID (text): Responsible User’s ID.
    • Industry (text): The associated Industry
    • Lead Status ID  (number): Lead Statuses which will be having a value pair of (status and status type).
    • Lead Source ID  (number): Lead Source i.e. web, phone etc.
    • Employee Count (text): Employee count for the lead’s organization
    • Lead Rating  (number): Lead’s Rating
    • Lead Description  (text): Lead’s Description
    • Visible Team ID  (number): If VISIBLE_TO is ‘Team’, then this should be a Team ID, which must be a valid TEAM_ID record locator.
    • Visible User IDs (number): If VISIBLE_TO is ‘Individuals’, then this should be a comma-separated list of User IDs. This field is always empty in the response. Upon successful POST or PUT an anonymous team is created from the list of IDs, and the response will contain a VISIBLE_TEAM_ID.
    • Tags (list of text): Set of Tags attached to the Lead.
  • Address 
    • Street (text): Street Number and Name of Address.
    • City (text): City.
    • State (text): State/Province.
    • Postcode (text): Zip or Postal Code.
    • Country (text): Country.
  • Custom Fields1
    • Lead Custom Field _(text): C_ustomizable field for the lead.
  • context
    • Execution ID (text): Unique identifier of Execution of the Flow.

• New Opportunity

  Triggers a Flow when a new opportunity is created in Insightly

  Options

  • Channel (drop down menu): The channel you wish to trigger the Flow when the event occurs within it.

  Output Fields

  • Opportunity
    • Opportunity ID (number): Unique identifier of the opportunity ID.
    • Opportunity Name (text): Name of the Opportunity.
    • Opportunity Details (text): Details of the Opportunity.
    • Probability (number): Percentage probability of winning the Opportunity, as an integer value from 0 to 100.
    • Bid Currency (text): Three-character code for a currency – e.g., USD, JPY. See Currency resource for available values.
    • Bid Amount (number): Potential value of the Opportunity, as an integer value.
    • Bid Type (text): Type of bid for the Opportunity. This field can have one of the following values: ‘Fixed Bid’, ‘Per Hour’, ‘Per Day’, ‘Per Week’, ‘Per Month’, or ‘Per Year’.
    • Bid Duration (text): Duration of the bid of the Opportunity, if ‘Per Hour/Day/etc.’, as an integer value.
    • Forecast Close Date (text): Forecasted Close Date of the Opportunity, in YYYY-MM-DD format.
    • Actual Close Date (text): Actual Close Date of the Opportunity, in YYYY-MM-DD format.
    • Category ID (number): The Category ID of the Opportunity, if it has been assigned to one. Must be a valid CATEGORY_ID or will generate a 400 error.
    • Pipeline ID (number): The Pipeline ID that the Opportunity is in if it has been assigned to one.
    • Stage ID (number): The Stage ID of the Stage that the Opportunity is in, if it has been assigned to one.
    • Opportunity State (text): This field must have one of the following values: ‘Open’, Abandoned’, ‘Lost’, ‘Suspended’, Won’.
    • Responsible User ID (number): ID of the User responsible for the Opportunity.
    • Owner User ID (number): User ID of the Opportunity record owner. Must be a valid Insightly user ID, or will generate a 400 error.
    • Date Created (text): Creation Date of the Opportunity, in YYYY-MM-DD format.
    • Date Updated (text): Updated Date of the Opportunity, in YYYY-MM-DD format.
    • Visible To (text): This field can have one of the following values: ‘Everyone’ (Default), ‘Owner’, ‘Team’, or ‘Individuals’.
    • Visible Team ID (number): If VISIBLE_TO is ‘Team’, then this should be a Team ID.
    • Visible User ID s(number): If VISIBLE_TO is ‘Individuals’, then this should be a comma-separated list of User IDs. This field is always empty in the response. Upon successful POST or PUT an anonymous team is created from the list of IDs, and the response will contain a VISIBLE_TEAM_ID.
    • Tags (list of text): Set of Tags attached to the Opportunity.
  • Custom Fields
    • Opportunity Custom Field (text): Unique customizable opportunity field.
  • context
    • Execution ID (text): Unique identifier of execution of the Flow.

• New Organization

  Triggers a Flow when a new organization is created in Insightly.

  Options

  • Channel (drop down menu): The channel you wish to trigger the Flow when a new organization is created within it.

  Output Fields

  • Organization
    • Organization ID (number): The unique identifier of the organization.
    • Organization Name (text): Name of organization
    • Background (text): Additional background notes, bio, etc.
    • Owner User ID _(text):  _User ID of the Contact Owner.
    • Date Created (text): Date the organization was created.
    • Date Updated (text): Date the organization was updated.
    • Visible To (text): This field can have one of the following values: ‘Everyone’ (Default), ‘Owner’, ‘Team’, or ‘Individuals’.
    • Visible Team ID (number): If VISIBLE_TO is ‘Team’, then this should be a Team ID.
    • Visible User IDs (number): If VISIBLE_TO is ‘Individuals’, then this should be a comma-separated list of User IDs. This field is always empty in the response. Upon successful POST or PUT an anonymous team is created from the list of IDs, and the response will contain a VISIBLE_TEAM_ID.
    • Tags (list of text):
    • Address (object):
      • Address ID (text): Unique identifier for the address.
      • Address Type (number): ADDRESS_TYPE must be one of the following values: ‘Postal’, ‘Work’, ‘Primary’, ‘Home’ or ‘Other’. ‘Postal’, ‘Work’ and ‘Primary’ map to the Mailing Address and ‘Home’ and ‘Other’ map to the Other Address.
      • Street (text): Street Number and Name of Address.
      • City (text): City.
      • State (text): State/Province.
      • Postcode (text): Zip or Postal Code.
      • Country (text): Country.
  • Custom Fields
    • Organization Custom Field (text): Unique customizable opportunity field.

• New Project

  Triggers a Flow when a project is created in Insightly.

  Options

  • Channel (drop down menu): The channel you wish to trigger the Flow when the event occurs within it.

  Output

  • Project
    • Project ID (number): The unique identifier of the project.
    • Project Name (text): The name of the new project.
    • Status (text): This field must have one of the following values: ‘Abandoned’, ‘Cancelled’, ‘Completed’, ‘Deferred’, ‘In Progress’, ‘Not Started’.
    • Project Details (text): Details about project.
    • Opportunity ID (text): Unique key of the Opportunity from which the Project may have been converted.
    • Date Started (text): Date Project started, in YYYY-MM-DD format
    • Date Completed (text): Date Project finished, in YYYY-MM-DD format
    • Responsible User ID (text): ID of the User responsible for the Project.
    • Owner User ID (text): User ID of the owner.
    • Date Created (text): Date Project created, in YYYY-MM-DD format
    • Date Updated (text): Date Project updated, in YYYY-MM-DD format
    • Category ID (text): The Category ID of the Project, if it has been assigned to one.
    • Pipeline ID (text): The Pipeline ID that the Project is in if it has been assigned to one.
    • Stage ID (text): The Stage ID of the Stage that the Project is in if it has been assigned to one.
    • Visible To (text): This field can have one of the following values: ‘Everyone’ (Default), ‘Owner’, ‘Team’, or ‘Individuals’.
    • Visible Team ID (text): If VISIBLE_TO is ‘Team’, then this should be a Team ID.
    • Visible User IDs (list of text): If VISIBLE_TO is ‘Individuals’, then this should be a comma-separated list of User IDs. This field is always empty in the response. Upon successful POST or PUT an anonymous team is created from the list of IDs, and the response will contain a VISIBLE_TEAM_ID.
    • Tags (list of text): Set of Tags attached to the Project.
  • Custom Fields
    • Project Custom Field (text): Any custom fields of the project.
    • Project Field II (text): The second part of the project field.
  • Execution ID 
    • Execution ID (text): Unique identifier of execution of the Flow.

• New Task

  Triggers a Flow when a new task is made in Insightly.

  Output Fields

  • Task
    • Task ID (number): Unique key of the Task record being linked.
    • Title (text): Title of the Task.
    • Category ID (number): The Category ID of the Task, if it has been assigned to one.
    • Due Date (text): Due Date of the Task, in YYYY-MM-DD format.
    • Public Visibility (T/F): True if Task is visible to others.
    • Project ID (text): ID of Project that the Task is linked to.
    • Details (text): Details of the Task.
    • Status (text): This field can have one of the following values: ‘Completed’, ‘Deferred’, ‘In Progress’, ‘Not Started’, ‘Waiting’.
    • Priority (text): This field can have one of the following integer values: 1 (Low), 2 (Normal), or 3 (High).
    • Assigned By User ID (number): ID of the user which assigned the Task.
    • Parent Task ID (number): Parent task ID must be integer.
    • Owner Visible (T/F): Used to determine if owner of assigned task wants to be kept notified of task
    • Responsible User ID (number): D of the User who is responsible for the Task.
    • Assigned Team ID (number): D of the Team which is responsible for the Task.
    • Time Assigned (text): Time the task was assigned.
    • Owner User ID (number): User ID of the Task record owner.
    • Date Created (text): Date the task was created.
    • Reminder Date (text): Reminder date and time of the Task, as Coordinated Universal Time.
  • context
    • Execution ID (text): Unique identifier of execution of the Flow.

• Opportunity Updated

  Opportunity Updated

  Triggers the Flow when a new opportunity is updated in Insightly.

  Options

  • Channel (drop down menu): Choose which channel you wish to trigger the Flow when an opportunity is created within it.

  Output Fields

  • Opportunity
    • Opportunity ID (number): Unique identifier of the opportunity ID.
    • Opportunity Name (text): Name of the Opportunity.
    • Opportunity Details (text): Details of the Opportunity.
    • Probability (number): Percentage probability of winning the Opportunity, as an integer value from 0 to 100.
    • Bid Currency (text): Three-character code for a currency – e.g., USD, JPY. See Currency resource for available values.
    • Bid Amount (number): Potential value of the Opportunity, as an integer value.
    • Bid Type (text): Type of bid for the Opportunity. This field can have one of the following values: ‘Fixed Bid’, ‘Per Hour’, ‘Per Day’, ‘Per Week’, ‘Per Month’, or ‘Per Year’.
    • Bid Duration (number): Duration of the bid of the Opportunity, if ‘Per Hour/Day/etc.’, as an integer value.
    • Forecast Close Date (text): Forecasted Close Date of the Opportunity, in YYYY-MM-DD format.
    • Actual Close Date (text): Actual Close Date of the Opportunity, in YYYY-MM-DD format.
    • Category ID (number): The Category ID of the Opportunity, if it has been assigned to one. Must be a valid CATEGORY_ID or will generate a 400 error.
    • Pipeline ID (number): The Pipeline ID that the Opportunity is in if it has been assigned to one.
    • Stage ID (number): The Stage ID of the Stage that the Opportunity is in if it has been assigned to one.
    • Opportunity State (text): This field must have one of the following values: ‘Open’, Abandoned’, ‘Lost’, ‘Suspended’, Won’.
    • Responsible User ID (number): ID of the User responsible for the Opportunity.
    • Owner User ID (number): User ID of the Opportunity record owner. Must be a valid Insightly user ID, or will generate a 400 error.
    • Date Created (text): Creation Date of the Opportunity, in YYYY-MM-DD format.
    • Date Updated (text): Updated Date of the Opportunity, in YYYY-MM-DD format.
    • Visible To (text): This field can have one of the following values: ‘Everyone’ (Default), ‘Owner’, ‘Team’, or ‘Individuals’.
    • Visible Team ID (number): If VISIBLE_TO is ‘Team’, then this should be a Team ID.
    • Visible User ID s(number): If VISIBLE_TO is ‘Individuals’, then this should be a comma-separated list of User IDs. This field is always empty in the response. Upon successful POST or PUT an anonymous team is created from the list of IDs, and the response will contain a VISIBLE_TEAM_ID.
    • Tags (list of text): Set of Tags attached to the Opportunity.
  • Custom Fields
    • Opportunity Custom Field (text): Unique customizable opportunity field.
  • context
    • Execution ID (text): Unique identifier of execution of the Flow.

• Organization Updated

  Organization Updated

  Triggers the Flow when an organization is updated in Insightly.

  Options

  • Channel (drop down menu): The channel you wish to trigger the Flow when an organization is updated within it.

  Output Fields

  • Organization
    • Organization ID (number): The unique identifier of the organization. This can be dragged from the create organization card.
    • Organization Name (text): Name of organization
    • Background (text): Additional background notes, bio, etc.
    • Owner User ID _(number):  _User ID of the Contact Owner.
    • Date Created (text): Date the organization was created.
    • Date Updated (text): Date the organization was updated.
    • Visible To (text): This field can have one of the following values: ‘Everyone’ (Default), ‘Owner’, ‘Team’, or ‘Individuals’.
    • Visible Team ID (text): If VISIBLE_TO is ‘Team’, then this should be a Team ID.
    • Visible User IDs (list of text): If VISIBLE_TO is ‘Individuals’, then this should be a comma-separated list of User IDs. This field is always empty in the response. Upon successful POST or PUT an anonymous team is created from the list of IDs, and the response will contain a VISIBLE_TEAM_ID.
    • Tags (list of text):
    • Address (object):
      • Address ID (number): Unique identifier of the address.
      • Address Type (text): ADDRESS_TYPE must be one of the following values: ‘Postal’, ‘Work’, ‘Primary’, ‘Home’ or ‘Other’. ‘Postal’, ‘Work’ and ‘Primary’ map to the Mailing Address and ‘Home’ and ‘Other’ map to the Other Address.
      • Street (text): Street Number and Name of Address.
      • City (text): City.
      • State (text): State/Province.
      • Postcode (text): Zip or Postal Code.
      • Country (text): Country.
  • Custom Fields
    • Organization Custom Field (text): Unique customizable opportunity field.
  • context
    • Execution ID (text): Unique identifier for execution of the Flow.

• Project Updated

  Triggers a Flow when a project is updated in Insightly.

  Options

  • Channel (drop down menu): The channel you wish to trigger the Flow when the event occurs within it.

  Output Fields

  • Project
    • Project ID (text): The identifier name of the project. This can be dragged from the read project or create project cards.
    • Project Name (text): The name of the project.
    • Status (text): This field must have one of the following values: ‘Abandoned’, ‘Cancelled’, ‘Completed’, ‘Deferred’, ‘In Progress’, ‘Not Started’.
    • Project Details (text): Details about project.
    • Opportunity ID (text): Unique key of the Opportunity from which the Project may have been converted.
    • Date Started (text): Date Project started, in YYYY-MM-DD format
    • Date Completed (text): Date Project completed, in YYYY-MM-DD format
    • Responsible User ID (text): ID of the User responsible for the Project.
    • Owner User ID (text): User ID of the owner.
    • Category ID (text): The Category ID of the Project, if it has been assigned to one.
    • Pipeline ID (text): The Pipeline ID that the Project is in if it has been assigned to one.
    • Stage ID (text): The Stage ID of the Stage that the Project is in if it has been assigned to one.
    • Visible To (text): This field can have one of the following values: ‘Everyone’ (Default), ‘Owner’, ‘Team’, or ‘Individuals’.
    • Visible Team ID (text): If VISIBLE_TO is ‘Team’, then this should be a Team ID.
    • Visible User IDs (list of text): If VISIBLE_TO is ‘Individuals’, then this should be a comma-separated list of User IDs. This field is always empty in the response. Upon successful POST or PUT an anonymous team is created from the list of IDs, and the response will contain a VISIBLE_TEAM_ID.
    • Tags (list of text): Set of Tags attached to the Project.
  • Custom Fields
    • Project Custom Field (text): Any custom fields of the project.
    • Project Field II (text): The second part of the project field
  • Context
    • Execution ID (text): Unique Identifier of execution of the Flow.

• Task Updated

  Start FLO when an existing task is updated

Actions

• Create Contact

  Adds a new contact.

  Input Fields

  • Contact
    • Salutation (text):  Mr/Mrs/etc.
    • First Name (text): User’s first name.
    • Last Name (text): User’s last name.
    • Work Email (list of text): User’s email.
    • Work Phone (list of text): User’s work phone.
    • Mobile Phone (list of text): User’s mobile phone.
    • Work Website (list of text): User’s work website.
    • Background (text): Additional background notes, bio, etc.
    • Default Linked Organization (text): Select an organization defined in the Links field to be marked as default. If empty, or is not included in Links, or is not a valid ORGANISATION_ID, the first organization link will be set as default.
    • Owner User ID (text): User ID of the Contact Owner.
    • Visible To (text): This field can have one of the following values: ‘Everyone’ (Default), ‘Owner’, ‘Team’, or ‘Individuals’.
    • Visible Team ID (text): If VISIBLE_TO is ‘Team’, then this should be a Team ID, which must be a valid TEAM_ID record locator.
    • Visible User IDs (text): If VISIBLE_TO is ‘Individuals’, then this should be a comma-separated list of User IDs. This field is always empty in the response. Upon successful POST or PUT an anonymous team is created from the list of IDs, and the response will contain a VISIBLE_TEAM_ID.
    • Tags (list of text): Set of Tags attached to the Contact.
  • Address
    • Address Type (text): ADDRESS_TYPE must be one of the following values: ‘Postal’, ‘Work’, ‘Primary’, ‘Home’ or ‘Other’. ‘Postal’, ‘Work’ and ‘Primary’ map to the Mailing Address and ‘Home’ and ‘Other’ map to the Other Address.
    • Street (text): Street Number and Name of Address.
    • City (text): City.
    • State (text): State/Province.
    • Postcode (text): Zip or Postal Code.
    • Country (text): Country.
  • Custom fields
    • Contact Custom Field (text): Customizable field for contact.

  Output Fields

  • Contact
    • Contact ID (text): ID of the contact just created.
    • Date Created (text): Date the contact was created.

• Create Lead

  Creates a new lead.

  Input Fields

  • Lead
    • Salutation (text): Salutation (Mr/Mrs/etc).
    • Title (text): Title (Principal/CFO/CEO).
    • First Name (text): First/Given Name.
    • Last Name (text): Last/Family/Surname of the Lead.
    • Organization Name (text): Organization Name.
    • Phone Number (text): Phone Number.
    • Mobile Phone Number (text): Mobile Number.
    • Fax Number (text): Fax Number
    • Email Address (text): Email Address
    • Website URL (text): Website URL Address.
    • Owner User ID (text): User ID of the Lead Owner.
    • Visible To (text): This field can have one of the following values: ‘Everyone’ (Default), ‘Owner’, ‘Team’, or ‘Individuals’.
    • Responsible User ID (text): Responsible User’s ID.
    • Industry (text): The associated Industry
    • Lead Status ID  (text): Lead Statuses which will be having a value pair of (status and status type).
    • Lead Source ID  (text): Lead Source i.e. web, phone etc.
    • Visible Team ID  (text): If VISIBLE_TO is ‘Team’, then this should be a Team ID, which must be a valid TEAM_ID record locator.
    • Employee Count (text): Employee count for the lead’s organization
    • Lead Rating  (text): Lead’s Rating
    • Lead Description  (text): Lead’s Description
    • Visible User IDs (list of integers): If VISIBLE_TO is ‘Individuals’, then this should be a comma-separated list of User IDs. This field is always empty in the response. Upon successful POST or PUT an anonymous team is created from the list of IDs, and the response will contain a VISIBLE_TEAM_ID.
    • Tags (list of text): Set of Tags attached to the Lead.
  • Address (list of text):
    • Address Type (text): ADDRESS_TYPE must be one of the following values: ‘Postal’, ‘Work’, ‘Primary’, ‘Home’ or ‘Other’. ‘Postal’, ‘Work’ and ‘Primary’ map to the Mailing Address and ‘Home’ and ‘Other’ map to the Other Address.
    • Street (text): Street Number and Name of Address.
    • City (text): City.
    • State (text): State/Province.
    • Postcode (text): Zip or Postal Code.
    • Country (text): Country.
  • Custom Fields1
    • Lead Custom Field _(text): C_ustomizable field for the lead.

  Output Fields

  • Lead
    • Lead ID (text): Unique key of the Lead record.
    • Date Created (text): Date the Lead was created.

• Create Opportunity

  Creates a new opportunity.

  Input Fields

  • Opportunity
    • Opportunity Name (text): Name of the Opportunity.
    • Opportunity Details (text): Details of the Opportunity.
    • Probability (number): Percentage probability of winning the Opportunity, as an integer value from 0 to 100.
    • Bid Currency (text): Three-character code for a currency – e.g., USD, JPY. See Currency resource for available values.
    • Bid Amount (number): Potential value of the Opportunity, as an integer value.
    • Bid Type (text): Type of bid for the Opportunity. This field can have one of the following values: ‘Fixed Bid’, ‘Per Hour’, ‘Per Day’, ‘Per Week’, ‘Per Month’, or ‘Per Year’.
    • Bid Duration (number): Duration of the bid of the Opportunity, if ‘Per Hour/Day/etc.’, as an integer value.
    • Forecast Close Date (text): Forecasted Close Date of the Opportunity, in YYYY-MM-DD format.
    • Category ID (number): The Category ID of the Opportunity, if it has been assigned to one. Must be a valid CATEGORY_ID or will generate a 400 error.
    • Pipeline ID (number): The Pipeline ID that the Opportunity is in if it has been assigned to one.
    • Stage ID (number): The Stage ID of the Stage that the Opportunity is in, if it has been assigned to one.
    • Opportunity State (text): This field must have one of the following values: ‘Open’, Abandoned’, ‘Lost’, ‘Suspended’, Won’.
    • Responsible User ID (number): ID of the User responsible for the Opportunity.
    • Owner User ID (number): User ID of the Opportunity record owner. Must be a valid Insightly user ID, or will generate a 400 error.
    • Visible To (text): This field can have one of the following values: ‘Everyone’ (Default), ‘Owner’, ‘Team’, or ‘Individuals’.
    • Visible Team ID (number): If VISIBLE_TO is ‘Team’, then this should be a Team ID.
    • Visible User IDs (number): If VISIBLE_TO is ‘Individuals’, then this should be a comma-separated list of User IDs. This field is always empty in the response. Upon successful POST or PUT an anonymous team is created from the list of IDs, and the response will contain a VISIBLE_TEAM_ID.
    • Tags (list of text): Set of Tags attached to the Opportunity.
  • Custom Fields
    • Opportunity Custom Field (text): Unique customizable opportunity field.

  Output Field

  • Opportunity
    • Opportunity ID (number): Unique identifier of the opportunity ID.

• Create Organization

  Creates an Organization in Insightly.

  Input Fields

  • Organization
    • Name (text): Name of organization
    • Background (text): Additional background notes, bio, etc.
    • Owner User ID _(text):  _User ID of the Contact Owner.
    • Visible To (text): This field can have one of the following values: ‘Everyone’ (Default), ‘Owner’, ‘Team’, or ‘Individuals’.
    • Visible Team ID (text): If VISIBLE_TO is ‘Team’, then this should be a Team ID, which must be a valid TEAM_ID record locator.
    • Visible User IDs (text): If VISIBLE_TO is ‘Individuals’, then this should be a comma-separated list of User IDs. This field is always empty in the response. Upon successful POST or PUT an anonymous team is created from the list of IDs, and the response will contain a VISIBLE_TEAM_ID.
    • Tags (list of text):
  • Address
    • Address Type (text): ADDRESS_TYPE must be one of the following values: ‘Postal’, ‘Work’, ‘Primary’, ‘Home’ or ‘Other’. ‘Postal’, ‘Work’ and ‘Primary’ map to the Mailing Address and ‘Home’ and ‘Other’ map to the Other Address.
    • Street (text): Street Number and Name of Address.
    • City (text): City.
    • State (text): State/Province.
    • Postcode (text): Zip or Postal Code.
    • Country (text): Country.
  • Custom Fields
    • Organization Custom Field

  Output Fields

  • Contact
    • Organization ID (text): The unique identifier of the organization.
    • Date Created (text): Date the organization was created.

• Create Project

  Create a new project and declare its attributes.

  Input Fields

  • Project
    • Project Name (text): The name of the new project.
    • Status (text): This field must have one of the following values: ‘Abandoned’, ‘Cancelled’, ‘Completed’, ‘Deferred’, ‘In Progress’, ‘Not Started’.
    • Project Details (text): Details about project.
    • Opportunity ID (text): Unique key of the Opportunity from which the Project may have been converted.
    • Date Started (text): Date Project started, in YYYY-MM-DD format
    • Owner User ID (text): User ID of the owner.
    • Responsible User ID (text): ID of the User responsible for the Project.
    • Category ID (text): The Category ID of the Project, if it has been assigned to one.
    • Pipeline ID (text): The Pipeline ID that the Project is in if it has been assigned to one.
    • Stage ID (text): The Stage ID of the Stage that the Project is in if it has been assigned to one.
    • Visible To (text): This field can have one of the following values: ‘Everyone’ (Default), ‘Owner’, ‘Team’, or ‘Individuals’.
    • Visible Team ID (text): If VISIBLE_TO is ‘Team’, then this should be a Team ID.
    • Visible User IDs (list of text): If VISIBLE_TO is ‘Individuals’, then this should be a comma-separated list of User IDs. This field is always empty in the response. Upon successful POST or PUT an anonymous team is created from the list of IDs, and the response will contain a VISIBLE_TEAM_ID.
    • Tags _(list of text): _Set of Tags attached to the Project.
  • Custom Fields
    • Project Custom Field (text): Any custom fields of the project.
    • Project Field II (text): The second part of the project field.

  Output Fields

  • Project
    • Project ID (text): The unique identifier of the project.
    • Date Created (text): The date the project was created.

• Create Task

  Creates a task.

  Input Fields

  • Task
    • Title (text): Title of the Task.
    • Category ID (text): The Category ID of the Task, if it has been assigned to one.
    • Due Date (text): Due Date of the Task, in YYYY-MM-DD format.
    • Public Visibility (T/F): True if Task is visible to others.
    • Completed (T/F): True if Task has been completed.
    • Project ID (text): ID of Project that the Task is linked to.
    • Details (text): Details of the Task.
    • Status (text): This field can have one of the following values: ‘Completed’, ‘Deferred’, ‘In Progress’, ‘Not Started’, ‘Waiting’.
    • Priority (text): This field can have one of the following integer values: 1 (Low), 2 (Normal), or 3 (High).
    • Parent Task ID (text): Parent task ID must be integer.
    • Owner Visible (T/F): Used to determine if owner of assigned task wants to be kept notified of task
    • Responsible User ID (text): D of the User who is responsible for the Task.
    • Assigned Team ID (text): D of the Team which is responsible for the Task.
    • Owner User ID (text): User ID of the Task record owner.
    • Reminder Date (text): Reminder date and time of the Task, as Coordinated Universal Time.

  Output Fields

  • Task
    • Task ID (text): Unique key of the Task record being linked.
    • Time Created (text): Time the task was created.

• Read Contact

  Returns information about a contact.

  Input Field

  • Contact
    • Contact ID (text): ID of the contact to read. This can be dragged from the Create Contact card.

  Output Fields

  • Contact
    • Salutation (text):  Mr/Mrs/etc.
    • First Name (text): User’s first name.
    • Last Name (text): User’s last name.
    • Work Email (list of text): User’s email.
    • Work Phone (list of text): User’s work phone.
    • Mobile Phone (list of text): User’s mobile phone.
    • Work Website (list of text): User’s work website.
    • Background (text): Additional background notes, bio, etc.
    • Default Linked Organization (text): An organization defined in the Links field to be marked as default. If empty, or is not included in Links, or is not a valid ORGANISATION_ID, the first organization link will be set as default.
    • Owner User ID (text): User ID of the Contact Owner.
    • Visible To (text): This field can have one of the following values: ‘Everyone’ (Default), ‘Owner’, ‘Team’, or ‘Individuals’.
    • Visible Team ID (text): If VISIBLE_TO is ‘Team’, then this should be a Team ID, which must be a valid TEAM_ID record locator.
    • Visible User IDs (text): If VISIBLE_TO is ‘Individuals’, then this should be a comma-separated list of User IDs. This field is always empty in the response. Upon successful POST or PUT an anonymous team is created from the list of IDs, and the response will contain a VISIBLE_TEAM_ID.
    • Tags (list of text): Set of Tags attached to the Contact.
    • Address (list of text):
      • Address Type (text): ADDRESS_TYPE must be one of the following values: ‘Postal’, ‘Work’, ‘Primary’, ‘Home’ or ‘Other’. ‘Postal’, ‘Work’ and ‘Primary’ map to the Mailing Address and ‘Home’ and ‘Other’ map to the Other Address.
      • Street (text): Street Number and Name of Address.
      • City (text): City.
      • State (text): State/Province.
      • Postcode (text): Zip or Postal Code.
      • Country (text): Country.
  • Custom fields
    • Contact Custom Field (text): Customizable field for contact.

• Read Lead

  Read the information about a lead.

  Input Fields

  • Lead
    • Lead ID (text): Unique key of the Lead record. This can be dragged from the create lead card. Or found by using ‘Search Leads’.

  Output Fields

  • Lead
    • Salutation (text): Salutation (Mr/Mrs/etc).
    • Title (text): Title (Principal/CFO/CEO).
    • First Name (text): First/Given Name.
    • Last Name (text): Last/Family/Surname of the Lead.
    • Organization Name (text): Organization Name.
    • Phone Number (text): Phone Number.
    • Mobile Phone Number (text): Mobile Number.
    • Fax Number (text): Fax Number
    • Email Address (text): Email Address
    • Website URL (text): Website URL Address.
    • Owner User ID (integers): User ID of the Lead Owner.
    • Date Created (text): Date the Lead was created.
    • Date Update (text): Date the Lead was updated.
    • Converted (T/F): Date and time Lead record updated, as Coordinated Universal Time (read only, automatically generated by server)
    • Converted Date(text): Date and time Lead record converted to opportunity, as Coordinated Universal Time (read only, automatically generated by server)
    • Converted Contact ID (integers): The Contact ID resulted from a Lead conversion process to Opportunity
    • Converted Organization ID (integers): The Organization ID resulted from a Lead conversion process to Opportunity
    • Converted Opportunity ID (integers): The Opportunity ID resulted from a Lead conversion process
    • Visible To (text): This field can have one of the following values: ‘Everyone’ (Default), ‘Owner’, ‘Team’, or ‘Individuals’.
    • Visible Team IDs (integer): If VISIBLE_TO is ‘Team’, then this should be a Team ID, which must be a valid TEAM_ID record locator.
    • Visible User IDs (list of text): If VISIBLE_TO is ‘Individuals’, then this should be a comma-separated list of User IDs. This field is always empty in the response. Upon successful POST or PUT an anonymous team is created from the list of IDs, and the response will contain a VISIBLE_TEAM_ID.
    • Responsible User ID (integers): Responsible User’s ID.
    • Industry (text): The associated Industry
    • Lead Status ID  (integers): Lead Statuses which will be having a value pair of (status and status type).
    • Lead Source ID  (integers): Lead Source i.e. web, phone etc.
    • Employee Count (text): Employee count for the lead’s organization
    • Lead Rating  (text): Lead’s Rating
    • Lead Description  (text): Lead’s Description
    • Tags (list of text): Set of Tags attached to the Lead.
  • Address (list of text):
    • Street (text): Street Number and Name of Address.
    • City (text): City.
    • State (text): State/Province.
    • Postcode (text): Zip or Postal Code.
    • Country (text): Country.
  • Custom Fields1
    • Lead Custom Field _(text): C_ustomizable field for the lead.

• Read Opportunity

  Reads an opportunity.

  Input Fields

  • Opportunity
    • Opportunity ID (text): The ID of the opportunity. This can be dragged from the create opportunity card.

  Output Fields

  • Opportunity
    • Opportunity Name (text): Name of the Opportunity.
    • Opportunity Details (text): Details of the Opportunity.
    • Probability (text): Percentage probability of winning the Opportunity, as an integer value from 0 to 100.
    • Bid Currency (text): Three-character code for a currency – e.g., USD, JPY. See Currency resource for available values.
    • Bid Amount (text): Potential value of the Opportunity, as an integer value.
    • Bid Type (text): Type of bid for the Opportunity. This field can have one of the following values: ‘Fixed Bid’, ‘Per Hour’, ‘Per Day’, ‘Per Week’, ‘Per Month’, or ‘Per Year’.
    • Bid Duration (text): Duration of the bid of the Opportunity, if ‘Per Hour/Day/etc.’, as an integer value.
    • Forecast Close Date (text): Forecasted Close Date of the Opportunity, in YYYY-MM-DD format.
    • Actual Close Date (text):   Close Date of the Opportunity, in YYYY-MM-DD format.
    • Category ID (text): The Category ID of the Opportunity, if it has been assigned to one. Must be a valid CATEGORY_ID or will generate a 400 error.
    • Pipeline ID (text): The Pipeline ID that the Opportunity is in if it has been assigned to one.
    • Stage ID (text): The Stage ID of the Stage that the Opportunity is in if it has been assigned to one.
    • Opportunity State (text): This field must have one of the following values: ‘Open’, Abandoned’, ‘Lost’, ‘Suspended’, Won’.
    • Responsible User ID (text): ID of the User responsible for the Opportunity.
    • Owner User ID (text): User ID of the Opportunity record owner. Must be a valid Insightly user ID, or will generate a 400 error.
    • Date Created (text): Date the opportunity was created.
    • Date Updated (text): Date the opportunity was updated.
    • Tags (list of text): Set of Tags attached to the Opportunity.
  • Custom Fields
    • Opportunity Custom Field (text): Unique customizable opportunity field.

• Read Organization

  Read an Organization.

  Input Field

  • Organization
    • Organization ID (text): The unique identifier of the organization. This can be dragged from the create organization card.

  Output Fields

  • Organization
    • Organization Name (text): Name of organization
    • Background (text): Additional background notes, bio, etc.
    • Owner User ID _(text):  _User ID of the Contact Owner.
    • Date Created (text): Date the organization was created.
    • Date Updated (text): Date the organization was updated.
    • Tags (list of text):
    • Address (list of text):
      • Address Type (text): ADDRESS_TYPE must be one of the following values: ‘Postal’, ‘Work’, ‘Primary’, ‘Home’ or ‘Other’. ‘Postal’, ‘Work’ and ‘Primary’ map to the Mailing Address and ‘Home’ and ‘Other’ map to the Other Address.
      • Street (text): Street Number and Name of Address.
      • City (text): City.
      • State (text): State/Province.
      • Postcode (text): Zip or Postal Code.
      • Country (text): Country.
  • Custom Fields1
    • Organization Custom Field (text): Unique customizable opportunity field.

• Read Project

  Read a new project and return its attributes.

  Input Field

  • Project ID (text): The unique identifier of the project. This can be dragged from the create project card.

  Output Fields

  • Project
    • Project Name (text): The name of the project.
    • Status (text): The status is: ‘Abandoned’, ‘Cancelled’, ‘Completed’, ‘Deferred’, ‘In Progress’, ‘Not Started’.
    • Project Details (text): Details about the project.
    • Opportunity ID (text): Unique key of the Opportunity from which the Project may have been converted.
    • Date Started (text): Date Project started, in YYYY-MM-DD format
    • Date Completed (text): Date Project completed, in YYYY-MM-DD format
    • Responsible User ID (text): ID of the User responsible for the Project.
    • Owner User ID (text): User ID of the owner.
    • Category ID (text): The Category ID of the Project, if it has been assigned to one.
    • Pipeline ID (text): The Pipeline ID that the Project is in if it has been assigned to one.
    • Stage ID (text): The Stage ID of the Stage that the Project is in if it has been assigned to one.
    • Tags (list of text): Set of Tags attached to the Project.
  • Custom Fields
    • Project Custom Field (text): Any custom fields of the project.
    • Project Field II (text): The second part of the project field.

• Read Task

  Reads a task.

  Input Field

  • Task
    • Task ID (text): Unique key of the Task record being linked. This can be dragged from the create task card.

  Output Fields

  • Task
    • Title (text): Title of the Task.
    • Category ID (text): The Category ID of the Task, if it has been assigned to one.
    • Due Date (text): Due Date of the Task, in YYYY-MM-DD format.
    • Public Visibility (T/F): True if Task is visible to others.
    • Completed (T/F): True if Task has been completed.
    • Project ID (text): ID of Project that the Task is linked to.
    • Details (text): Details of the Task.
    • Status (text): This field can have one of the following values: ‘Completed’, ‘Deferred’, ‘In Progress’, ‘Not Started’, ‘Waiting’.
    • Priority (text): This field can have one of the following integer values: 1 (Low), 2 (Normal), or 3 (High).
    • Percentage Complete (text): Percentage completion of the Task, in integer increments of 5 from 0 to 100– e.g., 0, 5, 10 , 15, etc.
    • Start Date (text): Start date of the Task, in YYYY-MM-DD format.
    • Assigned By User ID (text): The ID of the user that assigned the task.
    • Parent Task ID (text): Parent task ID must be integer.
    • Owner Visible (T/F): Used to determine if owner of assigned task wants to be kept notified of task
    • Responsible User ID (text): D of the User who is responsible for the Task.
    • Assigned Team ID (text): D of the Team which is responsible for the Task.
    • Time Assigned (text): Time the task was assigned.
    • Owner User ID (text): User ID of the Task record owner.
    • Date Created (text): Date the task was created.
    • Date Updated (text): Date the task was updated.
    • Reminder Date (text): Reminder date and time of the Task, as Coordinated Universal Time.
    • Reminder Sent (T/F): Status of the reminder’s delivery.

• Read User

  Reads information about a user. Input Field

  • User
    • User ID (text): The ID of the user to be found.

  Output Fields

  • User
    • Contact ID (text): Unique key of the Contact record.
    • Instance ID (text): Unique key of the Instance record.
    • First Name _(text):  _First name of the user.
    • Last Name (text): Last name of the user.
    • Timezone ID (text): Unique key of the time zone.
    • Email Address (text): Email Address of the user.
    • Date Created (text): The date the user was created.
    • Date Updated (text): The date the user was updated.
    • Contact Display (text): Displayed name of the contact.
    • Contact Order (text): Order of the contact.

• Search Contacts

  Searches contacts by a chosen value.

  Options

  • Search by (drop down menu): The type of value you wish to search with.

  Input Field

  • Field
    • Value (text): Enter a value to search contacts; should correspond to the value type chosen in the options.

  Output Field

  • Contact
    • Contact ID (text): The ID of the contact that was found.

• Search Leads

  Searches for a lead by a value.

  Options

  • Search by (text): Name, Last Name, Organization Name, Phone Number, Email ID, Tags, City, State, Postcode, Country, or Updated After.

  Input Field

  • Field
    • Value (text): Value to search leads for. Should correspond to the chosen option.

  Output Field

  • Lead
    • Lead ID (text): The ID of the lead that was found.

• Search Opportunities

  Searches opportunities by a value.

  Options

  • Search by (text): Opportunity Name, Opportunity State, Forcast Close Date, Actual Close Date, Category ID, Pipeline ID, Stage ID, Responsible User ID, Owner User ID, Tags,  or Updated After

  Input Field

  • Field
    • Value (text): Value to search opportunities for

  Output Field

  • Opportunity
    • Opportunity ID (text): The ID of the opportunity that matched.

• Search Organizations

  Searches organizations by a value.

  Options

  • Search by (text): Organization Name, City, State, Postcode, Country, Email ID, Email Domain, Phone Number, Tags, and Updated After.

  Input Field

  • Field
    • Value (text): Value to search organizations.

  Output Field

  • Organization
    • Organization ID (text): The ID of the organization that was found.

• Search Projects

  Search projects for a value.

  Options

  • Search By (drop down menu): The category/type of value you will search with.

  Input Field

  • Field
    • Value (text): The value to search projects for.

  Output Field

  • Project
    • Project ID (text): The ID of the project that contains the value.

• Search Users

  Searches users by their name and email.

  Input Fields

  • User
    • First Name (text): First name of the user.
    • Last Name (text): Last name of the user.
    • Email Address (text): Email Address of the user.

  Output Fields

  • User
    • User ID (text): The ID of the user found.
    • Contact ID (text): Unique key of the Contact record.
    • Instance ID (text): Unique key of the Instance record.
    • First Name _(text):  _First name of the user.
    • Last Name (text): Last name of the user.
    • Timezone ID (text): Unique key of the timezone.
    • Email Address (text): Email Address of the user.
    • Date Created (text): The date the user was created.
    • Date Updated (text): The date the user was updated.
    • Contact Display (text): Displayed name of the contact.
    • Contact Order (text): Order of the contact.

• Update Contact

  Updates a contact.

  Input Fields

  • Contact
    • Contact ID (text): Unique identifier of the contact to update. This can be dragged from the create contact card, or by using ‘Search Contacts’.
    • Salutation (text):  Mr/Mrs/etc.
    • First Name (text): User’s first name.
    • Last Name (text): User’s last name.
    • Work Email (list of text): User’s email.
    • Work Phone (list of text): User’s work phone.
    • Mobile Phone (list of text): User’s mobile phone.
    • Work Website (list of text): User’s work website.
    • Background (text): Additional background notes, bio, etc.
    • Default Linked Organization (text): Select an organization defined in the Links field to be marked as default. If empty, or is not included in Links, or is not a valid ORGANISATION_ID, the first organization link will be set as default.
    • Owner User ID (text): User ID of the Contact Owner.
    • Visible To (text): This field can have one of the following values: ‘Everyone’ (Default), ‘Owner’, ‘Team’, or ‘Individuals’.
    • Visible Team ID (text): If VISIBLE_TO is ‘Team’, then this should be a Team ID, which must be a valid TEAM_ID record locator.
    • Visible User IDs (text): If VISIBLE_TO is ‘Individuals’, then this should be a comma-separated list of User IDs. This field is always empty in the response. Upon successful POST or PUT an anonymous team is created from the list of IDs, and the response will contain a VISIBLE_TEAM_ID.
    • Tags (list of text): Set of Tags attached to the Contact.
  • Address
    • Address Type (text): ADDRESS_TYPE must be one of the following values: ‘Postal’, ‘Work’, ‘Primary’, ‘Home’ or ‘Other’. ‘Postal’, ‘Work’ and ‘Primary’ map to the Mailing Address and ‘Home’ and ‘Other’ map to the Other Address.
    • Street (text): Street Number and Name of Address.
    • City (text): City.
    • State (text): State/Province.
    • Postcode (text): Zip or Postal Code.
    • Country (text): Country.
  • Custom fields
    • Contact Custom Field (text): Customizable field for contact.

  Output Fields

  • Contact
    • Date Updated (text): Date the contact was updated.

• Update Lead

  Updates a lead.

  Input Fields

  • Lead
    • Lead ID (text): Unique key of the Lead record.
    • Salutation (text): Salutation (Mr/Mrs/etc).
    • Title (text): Title (Principal/CFO/CEO).
    • First Name (text): First/Given Name.
    • Last Name (text): Last/Family/Surname of the Lead.
    • Organization Name (text): Organization Name.
    • Phone Number (text): Phone Number.
    • Mobile Phone Number (text): Mobile Number.
    • Fax Number (text): Fax Number
    • Email Address (text): Email Address
    • Website URL (text): Website URL Address.
    • Owner User ID (text): User ID of the Lead Owner.
    • Visible To (text): This field can have one of the following values: ‘Everyone’ (Default), ‘Owner’, ‘Team’, or ‘Individuals’.
    • Responsible User ID (text): Responsible User’s ID.
    • Industry (text): The associated Industry
    • Lead Status ID  (text): Lead Statuses which will be having a value pair of (status and status type).
    • Lead Source ID  (text): Lead Source i.e. web, phone etc.
    • Visible Team ID  (text): If VISIBLE_TO is ‘Team’, then this should be a Team ID, which must be a valid TEAM_ID record locator.
    • Employee Count (text): Employee count for the lead’s organization
    • Lead Rating  (text): Lead’s Rating
    • Lead Description  (text): Lead’s Description
    • Visible User IDs (list of integers): If VISIBLE_TO is ‘Individuals’, then this should be a comma-separated list of User IDs. This field is always empty in the response. Upon successful POST or PUT an anonymous team is created from the list of IDs, and the response will contain a VISIBLE_TEAM_ID.
    • Tags (list of text): Set of Tags attached to the Lead.

  • Address (list of text):

    • Street (text): Street Number and Name of Address.
    • City (text): City.
    • State (text): State/Province.
    • Postcode (text): Zip or Postal Code.
    • Country (text): Country.

  • Custom Fields1

    • Lead Custom Field _(text): C_ustomizable field for the lead.

  Output Fields

  • Date Updated (text): Date the lead was updated.

• Update Opportunity

  Updates an opportunity.

  Input Fields

  • Opportunity
    • Opportunity ID (text): Unique identifier of the opportunity ID.
    • Opportunity Name (text): Name of the Opportunity.
    • Opportunity Details (text): Details of the Opportunity.
    • Probability (text): Percentage probability of winning the Opportunity, as an integer value from 0 to 100.
    • Bid Currency (text): Three-character code for a currency – e.g., USD, JPY. See Currency resource for available values.
    • Bid Amount (text): Potential value of the Opportunity, as an integer value.
    • Bid Type (text): Type of bid for the Opportunity. This field can have one of the following values: ‘Fixed Bid’, ‘Per Hour’, ‘Per Day’, ‘Per Week’, ‘Per Month’, or ‘Per Year’.
    • Bid Duration (text): Duration of the bid of the Opportunity, if ‘Per Hour/Day/etc.’, as an integer value.
    • Forecast Close Date (text): Forecasted Close Date of the Opportunity, in YYYY-MM-DD format.
    • Category ID (text): The Category ID of the Opportunity, if it has been assigned to one. Must be a valid CATEGORY_ID or will generate a 400 error.
    • Pipeline ID (text): The Pipeline ID that the Opportunity is in if it has been assigned to one.
    • Stage ID (text): The Stage ID of the Stage that the Opportunity is in, if it has been assigned to one.
    • Opportunity State (text): This field must have one of the following values: ‘Open’, Abandoned’, ‘Lost’, ‘Suspended’, Won’.
    • Responsible User ID (text): ID of the User responsible for the Opportunity.
    • Owner User ID (text): User ID of the Opportunity record owner. Must be a valid Insightly user ID, or will generate a 400 error.
    • Visible To (text): This field can have one of the following values: ‘Everyone’ (Default), ‘Owner’, ‘Team’, or ‘Individuals’.
    • Visible Team ID (text): If VISIBLE_TO is ‘Team’, then this should be a Team ID.
    • Visible User ID s(text): If VISIBLE_TO is ‘Individuals’, then this should be a comma-separated list of User IDs. This field is always empty in the response. Upon successful POST or PUT an anonymous team is created from the list of IDs, and the response will contain a VISIBLE_TEAM_ID.
    • Tags (list of text): Set of Tags attached to the Opportunity.
  • Custom Fields
  • * Opportunity Custom Field (text): Unique customizable opportunity field.

  Output Fields

  • Opportunity
    • Date Updated (text): Date the opportunity was updated.

• Update Organization

  Update an Organization.

  Input

  • Organization
    • Organization ID (text): The unique identifier of the organization. This can be dragged from the create organization card.
    • Organization Name (text): Name of organization
    • Background (text): Additional background notes, bio, etc.
    • Owner User ID _(text):  _User ID of the Contact Owner.
    • Date Created (text): Date the organization was created.
    • Tags (list of text):
  • Address (list of text):
    • Address Type (text): ADDRESS_TYPE must be one of the following values: ‘Postal’, ‘Work’, ‘Primary’, ‘Home’ or ‘Other’. ‘Postal’, ‘Work’ and ‘Primary’ map to the Mailing Address and ‘Home’ and ‘Other’ map to the Other Address.
    • Street (text): Street Number and Name of Address.
    • City (text): City.
    • State (text): State/Province.
    • Postcode (text): Zip or Postal Code.
    • Country (text): Country.
  • Custom Fields
    • Organization Custom Field (text): Unique customizable opportunity field.

  Output

  • Organization
    • Time Updated (text): Time the organization was updated.

• Update Project

  Update a project and change its attributes.

  Input Fields

  • Project
    • Project Name (text): The name of the project.
    • Project ID (text): The identifier name of the project. This can be dragged from the read project or create project cards.
    • Status (text): This field must have one of the following values: ‘Abandoned’, ‘Cancelled’, ‘Completed’, ‘Deferred’, ‘In Progress’, ‘Not Started’.
    • Project Details (text): Details about project.
    • Opportunity ID (text): Unique key of the Opportunity from which the Project may have been converted.
    • Date Started (text): Date Project started, in YYYY-MM-DD format
    • Owner User ID (text): User ID of the owner.
    • Responsible User ID (text): ID of the User responsible for the Project.
    • Category ID (text): The Category ID of the Project, if it has been assigned to one.
    • Pipeline ID (text): The Pipeline ID that the Project is in if it has been assigned to one.
    • Visible To (text): This field can have one of the following values: ‘Everyone’ (Default), ‘Owner’, ‘Team’, or ‘Individuals’.
    • Stage ID (text): The Stage ID of the Stage that the Project is in if it has been assigned to one.
    • Visible Team ID (text): If VISIBLE_TO is ‘Team’, then this should be a Team ID.
    • Visible User IDs (list of text): If VISIBLE_TO is ‘Individuals’, then this should be a comma-separated list of User IDs. This field is always empty in the response. Upon successful POST or PUT an anonymous team is created from the list of IDs, and the response will contain a VISIBLE_TEAM_ID.
    • Tags (list of text): Set of Tags attached to the Project.
  • Custom Fields
    • Project Custom Field (text): Any custom fields of the project.
    • Project Field II (text): The second part of the project field.

  Output Fields

  • Project
    • Date Updated (text): The date the project was updated.

• Update Task

  Updates an existing task in Insightly.

  Input Fields

  • Task
    • Task ID (text): Unique key of the Task record being linked. This can be dragged from the create task card.
    • Title (text): Title of the Task.
    • Category ID (text): The Category ID of the Task, if it has been assigned to one.
    • Due Date (text): Due Date of the Task, in YYYY-MM-DD format.
    • Public Visibility (T/F): True if Task is visible to others.
    • Completed (T/F): True if Task has been completed.
    • Project ID (text): ID of Project that the Task is linked to.
    • Details (text): Details of the Task.
    • Status (text): This field can have one of the following values: ‘Completed’, ‘Deferred’, ‘In Progress’, ‘Not Started’, ‘Waiting’.
    • Priority (text): This field can have one of the following integer values: 1 (Low), 2 (Normal), or 3 (High).
    • Percentage Complete (text): Percentage completion of the Task, in integer increments of 5 from 0 to 100– e.g., 0, 5, 10 , 15, etc.
    • Date Started (text): Date the task was started.
    • Completed (T/F): True if Task has been completed.
    • Date Completed (text): Date the task was completed.
    • Parent Task ID (text): Parent task ID must be integer.
    • Owner Visible (T/F): Used to determine if owner of assigned task wants to be kept notified of task
    • Responsible User ID (text): D of the User who is responsible for the Task.
    • Assigned Team ID (text): D of the Team which is responsible for the Task.
    • Owner User ID (text): User ID of the Task record owner.
    • Reminder Date (text): Reminder date and time of the Task, as Coordinated Universal Time.

  Output Field

  • Task
    • Date Updated (text): Date the task was updated.