ByteChef LogoByteChef
Components

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.

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

NameLabelTypeDescriptionRequired
clientIdClient IdSTRINGtrue
clientSecretClient SecretSTRINGtrue

Actions

Create Company

Name: createCompany

Creates a new company.

Properties

NameLabelTypeDescriptionRequired
addressCompanyAddressOBJECT
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

NameTypeDescription
addressOBJECT
Properties {STRING(country_code), STRING(line1), STRING(line2), STRING(locality), STRING(region), STRING(zip_code), STRING(zip_four)}
company_nameSTRING
custom_fieldsARRAY
Items [{{}(content), INTEGER(id)}]
email_addressSTRING
email_opted_inBOOLEAN
Options true, false
email_statusSTRING
Options UnengagedMarketable, SingleOptIn, DoubleOptin, Confirmed, UnengagedNonMarketable, NonMarketable, Lockdown, Bounce, HardBounce, Manual, Admin, System, ListUnsubscribe, Feedback, Spam, Invalid, Deactivated
fax_numberOBJECT
Properties {STRING(number), STRING(type)}
idINTEGER
notesSTRING
phone_numberOBJECT
Properties {STRING(extension), STRING(number), STRING(type)}
websiteSTRING

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

NameLabelTypeDescriptionRequired
completedCompletedBOOLEAN
Options true, false
false
completion_dateCompletion DateDATE_TIMEfalse
contactBasicContactOBJECT
Properties {STRING(email), STRING(first_name), INTEGER(id), STRING(last_name)}
false
creation_dateCreation DateDATE_TIMEfalse
descriptionDescriptionSTRINGfalse
due_dateDue DateDATE_TIMEfalse
funnel_idFunnel IdINTEGERfalse
jgraph_idJgraph IdINTEGERfalse
modification_dateModification DateDATE_TIMEfalse
priorityPriorityINTEGERfalse
remind_timeRemind TimeINTEGERValue 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
titleTitleSTRINGfalse
typeTypeSTRINGfalse
urlUrlSTRINGfalse
user_idUser IdINTEGERfalse

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

NameTypeDescription
completedBOOLEAN
Options true, false
completion_dateDATE_TIME
contactOBJECT
Properties {STRING(email), STRING(first_name), INTEGER(id), STRING(last_name)}
creation_dateDATE_TIME
descriptionSTRING
due_dateDATE_TIME
funnel_idINTEGER
jgraph_idINTEGER
modification_dateDATE_TIME
priorityINTEGER
remind_timeINTEGERValue in minutes before start_date to show pop-up reminder. Acceptable values are in [5,10,15,30,60,120,240,480,1440,2880]
titleSTRING
typeSTRING
urlSTRING
user_idINTEGER

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

NameLabelTypeDescriptionRequired
addressesAddressesARRAY
Items [{STRING(country_code), STRING(field), STRING(line1), STRING(line2), STRING(locality), STRING(postal_code), STRING(region), STRING(zip_code), STRING(zip_four)}]
false
anniversaryAnniversaryDATE_TIMEfalse
birthdayBirthdayDATE_TIMEfalse
companyRequestCompanyReferenceOBJECT
Properties {INTEGER(id)}
false
contact_typeContact TypeSTRINGfalse
custom_fieldsCustom FieldsARRAY
Items [{{}(content), INTEGER(id)}]
false
email_addressesEmail AddressesARRAY
Items [{STRING(email), STRING(field)}]
false
family_nameFamily NameSTRINGfalse
fax_numbersFax NumbersARRAY
Items [{STRING(field), STRING(number), STRING(type)}]
false
given_nameGiven NameSTRINGfalse
job_titleJob TitleSTRINGfalse
lead_source_idLead Source IdINTEGERfalse
middle_nameMiddle NameSTRINGfalse
opt_in_reasonOpt In ReasonSTRINGfalse
originCreateContactOriginOBJECT
Properties {STRING(ip_address)}
false
owner_idOwner IdINTEGERfalse
phone_numbersPhone NumbersARRAY
Items [{STRING(extension), STRING(field), STRING(number), STRING(type)}]
false
preferred_localePreferred LocaleSTRINGfalse
preferred_namePreferred NameSTRINGfalse
prefixPrefixSTRINGfalse
social_accountsSocial AccountsARRAY
Items [{STRING(name), STRING(type)}]
false
source_typeSource TypeSTRING
Options APPOINTMENT, FORMAPIHOSTED, FORMAPIINTERNAL, WEBFORM, INTERNALFORM, LANDINGPAGE, IMPORT, MANUAL, API, OTHER, UNKNOWN
false
spouse_nameSpouse NameSTRINGfalse
suffixSuffixSTRINGfalse
time_zoneTime ZoneSTRINGfalse
websiteWebsiteSTRINGfalse

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

NameTypeDescription
ScoreValueSTRING
addressesARRAY
Items [{STRING(country_code), STRING(field), STRING(line1), STRING(line2), STRING(locality), STRING(postal_code), STRING(region), STRING(zip_code), STRING(zip_four)}]
anniversaryDATE_TIME
birthdayDATE_TIME
companyOBJECT
Properties {STRING(company_name), INTEGER(id)}
company_nameSTRING
contact_typeSTRING
custom_fieldsARRAY
Items [{{}(content), INTEGER(id)}]
date_createdDATE_TIME
email_addressesARRAY
Items [{STRING(email), STRING(field)}]
email_opted_inBOOLEAN
Options true, false
email_statusSTRING
Options UnengagedMarketable, SingleOptIn, DoubleOptin, Confirmed, UnengagedNonMarketable, NonMarketable, Lockdown, Bounce, HardBounce, Manual, Admin, System, ListUnsubscribe, Feedback, Spam, Invalid, Deactivated
family_nameSTRING
fax_numbersARRAY
Items [{STRING(field), STRING(number), STRING(type)}]
given_nameSTRING
idINTEGER
job_titleSTRING
last_updatedDATE_TIME
lead_source_idINTEGER
middle_nameSTRING
opt_in_reasonSTRING
originOBJECT
Properties {DATE_TIME(date), STRING(ip_address)}
owner_idINTEGER
phone_numbersARRAY
Items [{STRING(extension), STRING(field), STRING(number), STRING(type)}]
preferred_localeSTRING
preferred_nameSTRING
prefixSTRING
relationshipsARRAY
Items [{INTEGER(id), INTEGER(linked_contact_id), INTEGER(relationship_type_id)}]
social_accountsARRAY
Items [{STRING(name), STRING(type)}]
source_typeSTRING
Options APPOINTMENT, FORMAPIHOSTED, FORMAPIINTERNAL, WEBFORM, INTERNALFORM, LANDINGPAGE, IMPORT, MANUAL, API, OTHER, UNKNOWN
spouse_nameSTRING
suffixSTRING
tag_idsARRAY
Items [INTEGER]
time_zoneSTRING
websiteSTRING

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