Keap

Keap is a customer comprehensive customer relationship management platform designed to help small businesses streamline sales, marketing, and customer management processes in one integrated system.

Categories: CRM

Type: keap/v1

Connections

Version: 1

OAuth2 Authorization Code

Properties

Name	Label	Type	Description	Required
clientId	Client Id	STRING		true
clientSecret	Client Secret	STRING		true

Actions

Create Company

Name: createCompany

Creates a new company.

Properties

Name	Label	Type	Description	Required
address	CompanyAddress	OBJECT Properties {{STRING(country_code), STRING(line1), STRING(line2), STRING(locality), STRING(region), STRING(zip_code), STRING(zip_four)}(address), STRING(company_name), [{{}(content), INTEGER(id)}](custom_fields), STRING(email_address), {STRING(number), STRING(type)}(fax_number), STRING(notes), STRING(opt_in_reason), {STRING(extension), STRING(number), STRING(type)}(phone_number), STRING(website)}		false

Example JSON Structure

{
  "label" : "Create Company",
  "name" : "createCompany",
  "parameters" : {
    "address" : {
      "address" : {
        "country_code" : "",
        "line1" : "",
        "line2" : "",
        "locality" : "",
        "region" : "",
        "zip_code" : "",
        "zip_four" : ""
      },
      "company_name" : "",
      "custom_fields" : [ {
        "content" : { },
        "id" : 1
      } ],
      "email_address" : "",
      "fax_number" : {
        "number" : "",
        "type" : ""
      },
      "notes" : "",
      "opt_in_reason" : "",
      "phone_number" : {
        "extension" : "",
        "number" : "",
        "type" : ""
      },
      "website" : ""
    }
  },
  "type" : "keap/v1/createCompany"
}

Output

Type: OBJECT

Properties

Name	Type	Description
address	OBJECT Properties {STRING(country_code), STRING(line1), STRING(line2), STRING(locality), STRING(region), STRING(zip_code), STRING(zip_four)}
company_name	STRING
custom_fields	ARRAY Items [{{}(content), INTEGER(id)}]
email_address	STRING
email_opted_in	BOOLEAN Options true, false
email_status	STRING Options UnengagedMarketable, SingleOptIn, DoubleOptin, Confirmed, UnengagedNonMarketable, NonMarketable, Lockdown, Bounce, HardBounce, Manual, Admin, System, ListUnsubscribe, Feedback, Spam, Invalid, Deactivated
fax_number	OBJECT Properties {STRING(number), STRING(type)}
id	INTEGER
notes	STRING
phone_number	OBJECT Properties {STRING(extension), STRING(number), STRING(type)}
website	STRING

Output Example

{
  "address" : {
    "country_code" : "",
    "line1" : "",
    "line2" : "",
    "locality" : "",
    "region" : "",
    "zip_code" : "",
    "zip_four" : ""
  },
  "company_name" : "",
  "custom_fields" : [ {
    "content" : { },
    "id" : 1
  } ],
  "email_address" : "",
  "email_opted_in" : false,
  "email_status" : "",
  "fax_number" : {
    "number" : "",
    "type" : ""
  },
  "id" : 1,
  "notes" : "",
  "phone_number" : {
    "extension" : "",
    "number" : "",
    "type" : ""
  },
  "website" : ""
}

Create Task

Name: createTask

Creates a new task.

Properties

Name	Label	Type	Description	Required
completed	Completed	BOOLEAN Options true, false		false
completion_date	Completion Date	DATE_TIME		false
contact	BasicContact	OBJECT Properties {STRING(email), STRING(first_name), INTEGER(id), STRING(last_name)}		false
creation_date	Creation Date	DATE_TIME		false
description	Description	STRING		false
due_date	Due Date	DATE_TIME		false
funnel_id	Funnel Id	INTEGER		false
jgraph_id	Jgraph Id	INTEGER		false
modification_date	Modification Date	DATE_TIME		false
priority	Priority	INTEGER		false
remind_time	Remind Time	INTEGER	`Value in minutes before start_date to show pop-up reminder. Acceptable values are in [`5`,`10`,`15`,`30`,`60`,`120`,`240`,`480`,`1440`,`2880`]`	false
title	Title	STRING		false
type	Type	STRING		false
url	Url	STRING		false
user_id	User Id	INTEGER		false

Example JSON Structure

{
  "label" : "Create Task",
  "name" : "createTask",
  "parameters" : {
    "completed" : false,
    "completion_date" : "2021-01-01T00:00:00",
    "contact" : {
      "email" : "",
      "first_name" : "",
      "id" : 1,
      "last_name" : ""
    },
    "creation_date" : "2021-01-01T00:00:00",
    "description" : "",
    "due_date" : "2021-01-01T00:00:00",
    "funnel_id" : 1,
    "jgraph_id" : 1,
    "modification_date" : "2021-01-01T00:00:00",
    "priority" : 1,
    "remind_time" : 1,
    "title" : "",
    "type" : "",
    "url" : "",
    "user_id" : 1
  },
  "type" : "keap/v1/createTask"
}

Output

Type: OBJECT

Properties

Name	Type	Description
completed	BOOLEAN Options true, false
completion_date	DATE_TIME
contact	OBJECT Properties {STRING(email), STRING(first_name), INTEGER(id), STRING(last_name)}
creation_date	DATE_TIME
description	STRING
due_date	DATE_TIME
funnel_id	INTEGER
jgraph_id	INTEGER
modification_date	DATE_TIME
priority	INTEGER
remind_time	INTEGER	Value in minutes before start_date to show pop-up reminder. Acceptable values are in [`5`,`10`,`15`,`30`,`60`,`120`,`240`,`480`,`1440`,`2880`]
title	STRING
type	STRING
url	STRING
user_id	INTEGER

Output Example

{
  "completed" : false,
  "completion_date" : "2021-01-01T00:00:00",
  "contact" : {
    "email" : "",
    "first_name" : "",
    "id" : 1,
    "last_name" : ""
  },
  "creation_date" : "2021-01-01T00:00:00",
  "description" : "",
  "due_date" : "2021-01-01T00:00:00",
  "funnel_id" : 1,
  "jgraph_id" : 1,
  "modification_date" : "2021-01-01T00:00:00",
  "priority" : 1,
  "remind_time" : 1,
  "title" : "",
  "type" : "",
  "url" : "",
  "user_id" : 1
}

Create Contact

Name: createContact

Creates a new contact.

Properties

Name	Label	Type	Required
addresses	Addresses	ARRAY Items [{STRING(country_code), STRING(field), STRING(line1), STRING(line2), STRING(locality), STRING(postal_code), STRING(region), STRING(zip_code), STRING(zip_four)}]	false
anniversary	Anniversary	DATE_TIME	false
birthday	Birthday	DATE_TIME	false
company	RequestCompanyReference	OBJECT Properties {INTEGER(id)}	false
contact_type	Contact Type	STRING	false
custom_fields	Custom Fields	ARRAY Items [{{}(content), INTEGER(id)}]	false
email_addresses	Email Addresses	ARRAY Items [{STRING(email), STRING(field)}]	false
family_name	Family Name	STRING	false
fax_numbers	Fax Numbers	ARRAY Items [{STRING(field), STRING(number), STRING(type)}]	false
given_name	Given Name	STRING	false
job_title	Job Title	STRING	false
lead_source_id	Lead Source Id	INTEGER	false
middle_name	Middle Name	STRING	false
opt_in_reason	Opt In Reason	STRING	false
origin	CreateContactOrigin	OBJECT Properties {STRING(ip_address)}	false
owner_id	Owner Id	INTEGER	false
phone_numbers	Phone Numbers	ARRAY Items [{STRING(extension), STRING(field), STRING(number), STRING(type)}]	false
preferred_locale	Preferred Locale	STRING	false
preferred_name	Preferred Name	STRING	false
prefix	Prefix	STRING	false
social_accounts	Social Accounts	ARRAY Items [{STRING(name), STRING(type)}]	false
source_type	Source Type	STRING Options APPOINTMENT, FORMAPIHOSTED, FORMAPIINTERNAL, WEBFORM, INTERNALFORM, LANDINGPAGE, IMPORT, MANUAL, API, OTHER, UNKNOWN	false
spouse_name	Spouse Name	STRING	false
suffix	Suffix	STRING	false
time_zone	Time Zone	STRING	false
website	Website	STRING	false

Example JSON Structure

{
  "label" : "Create Contact",
  "name" : "createContact",
  "parameters" : {
    "addresses" : [ {
      "country_code" : "",
      "field" : "",
      "line1" : "",
      "line2" : "",
      "locality" : "",
      "postal_code" : "",
      "region" : "",
      "zip_code" : "",
      "zip_four" : ""
    } ],
    "anniversary" : "2021-01-01T00:00:00",
    "birthday" : "2021-01-01T00:00:00",
    "company" : {
      "id" : 1
    },
    "contact_type" : "",
    "custom_fields" : [ {
      "content" : { },
      "id" : 1
    } ],
    "email_addresses" : [ {
      "email" : "",
      "field" : ""
    } ],
    "family_name" : "",
    "fax_numbers" : [ {
      "field" : "",
      "number" : "",
      "type" : ""
    } ],
    "given_name" : "",
    "job_title" : "",
    "lead_source_id" : 1,
    "middle_name" : "",
    "opt_in_reason" : "",
    "origin" : {
      "ip_address" : ""
    },
    "owner_id" : 1,
    "phone_numbers" : [ {
      "extension" : "",
      "field" : "",
      "number" : "",
      "type" : ""
    } ],
    "preferred_locale" : "",
    "preferred_name" : "",
    "prefix" : "",
    "social_accounts" : [ {
      "name" : "",
      "type" : ""
    } ],
    "source_type" : "",
    "spouse_name" : "",
    "suffix" : "",
    "time_zone" : "",
    "website" : ""
  },
  "type" : "keap/v1/createContact"
}

Output

Type: OBJECT

Properties

Name	Type	Description
ScoreValue	STRING
addresses	ARRAY Items [{STRING(country_code), STRING(field), STRING(line1), STRING(line2), STRING(locality), STRING(postal_code), STRING(region), STRING(zip_code), STRING(zip_four)}]
anniversary	DATE_TIME
birthday	DATE_TIME
company	OBJECT Properties {STRING(company_name), INTEGER(id)}
company_name	STRING
contact_type	STRING
custom_fields	ARRAY Items [{{}(content), INTEGER(id)}]
date_created	DATE_TIME
email_addresses	ARRAY Items [{STRING(email), STRING(field)}]
email_opted_in	BOOLEAN Options true, false
email_status	STRING Options UnengagedMarketable, SingleOptIn, DoubleOptin, Confirmed, UnengagedNonMarketable, NonMarketable, Lockdown, Bounce, HardBounce, Manual, Admin, System, ListUnsubscribe, Feedback, Spam, Invalid, Deactivated
family_name	STRING
fax_numbers	ARRAY Items [{STRING(field), STRING(number), STRING(type)}]
given_name	STRING
id	INTEGER
job_title	STRING
last_updated	DATE_TIME
lead_source_id	INTEGER
middle_name	STRING
opt_in_reason	STRING
origin	OBJECT Properties {DATE_TIME(date), STRING(ip_address)}
owner_id	INTEGER
phone_numbers	ARRAY Items [{STRING(extension), STRING(field), STRING(number), STRING(type)}]
preferred_locale	STRING
preferred_name	STRING
prefix	STRING
relationships	ARRAY Items [{INTEGER(id), INTEGER(linked_contact_id), INTEGER(relationship_type_id)}]
social_accounts	ARRAY Items [{STRING(name), STRING(type)}]
source_type	STRING Options APPOINTMENT, FORMAPIHOSTED, FORMAPIINTERNAL, WEBFORM, INTERNALFORM, LANDINGPAGE, IMPORT, MANUAL, API, OTHER, UNKNOWN
spouse_name	STRING
suffix	STRING
tag_ids	ARRAY Items [INTEGER]
time_zone	STRING
website	STRING

Output Example

{
  "ScoreValue" : "",
  "addresses" : [ {
    "country_code" : "",
    "field" : "",
    "line1" : "",
    "line2" : "",
    "locality" : "",
    "postal_code" : "",
    "region" : "",
    "zip_code" : "",
    "zip_four" : ""
  } ],
  "anniversary" : "2021-01-01T00:00:00",
  "birthday" : "2021-01-01T00:00:00",
  "company" : {
    "company_name" : "",
    "id" : 1
  },
  "company_name" : "",
  "contact_type" : "",
  "custom_fields" : [ {
    "content" : { },
    "id" : 1
  } ],
  "date_created" : "2021-01-01T00:00:00",
  "email_addresses" : [ {
    "email" : "",
    "field" : ""
  } ],
  "email_opted_in" : false,
  "email_status" : "",
  "family_name" : "",
  "fax_numbers" : [ {
    "field" : "",
    "number" : "",
    "type" : ""
  } ],
  "given_name" : "",
  "id" : 1,
  "job_title" : "",
  "last_updated" : "2021-01-01T00:00:00",
  "lead_source_id" : 1,
  "middle_name" : "",
  "opt_in_reason" : "",
  "origin" : {
    "date" : "2021-01-01T00:00:00",
    "ip_address" : ""
  },
  "owner_id" : 1,
  "phone_numbers" : [ {
    "extension" : "",
    "field" : "",
    "number" : "",
    "type" : ""
  } ],
  "preferred_locale" : "",
  "preferred_name" : "",
  "prefix" : "",
  "relationships" : [ {
    "id" : 1,
    "linked_contact_id" : 1,
    "relationship_type_id" : 1
  } ],
  "social_accounts" : [ {
    "name" : "",
    "type" : ""
  } ],
  "source_type" : "",
  "spouse_name" : "",
  "suffix" : "",
  "tag_ids" : [ 1 ],
  "time_zone" : "",
  "website" : ""
}

On this page