ByteChef LogoByteChef

Capsule CRM

Capsule CRM is a cloud-based customer relationship management platform designed to help businesses manage contacts, track sales opportunities, and collaborate with their teams efficiently.

Categories: CRM

Type: capsuleCRM/v1


Connections

Version: 1

Bearer Token

Properties

NameLabelTypeDescriptionRequired
tokenTokenSTRINGtrue

Connection Setup

Generate API Token

  1. Navigate to your Capsule CRM dashboard.
  2. Click here to access your preferences.
  3. Click on My Preferences.
  4. Click on API Authentication Tokens.
  5. Click on Generate New API Token.
  6. Enter name of your token.
  7. Enable every scope and click on Generate Token.
  8. Copy your token.
  9. Done 🚀.

Actions

Create Contact

Name: createContact

Creates a new Person or Organization

Properties

NameLabelTypeDescriptionRequired
typeTypeSTRING
Options person, organization
Represents if this party is a person or an organisation.true
firstNameFirst NameSTRINGThe first name of the person.true
lastNameLast NameSTRINGThe last name of the person.true
nameNameSTRINGThe name of the organisation.true
aboutAboutSTRINGA short description of the party.false
emailAddressesEmail AddressesARRAY
Items [{STRING(address), STRING(type)}]
An array of all the email addresses associated with this party.false
addressesAddressesARRAY
Items [{STRING(type), STRING(street), STRING(city), STRING(state), STRING(country), STRING(zip)}]
An array of all the addresses associated with this party.false
phoneNumbersPhone NumbersARRAY
Items [{STRING(type), STRING(number)}]
An array of all the phone numbers associated with this party.false

Example JSON Structure

{
  "label" : "Create Contact",
  "name" : "createContact",
  "parameters" : {
    "type" : "",
    "firstName" : "",
    "lastName" : "",
    "name" : "",
    "about" : "",
    "emailAddresses" : [ {
      "address" : "",
      "type" : ""
    } ],
    "addresses" : [ {
      "type" : "",
      "street" : "",
      "city" : "",
      "state" : "",
      "country" : "",
      "zip" : ""
    } ],
    "phoneNumbers" : [ {
      "type" : "",
      "number" : ""
    } ]
  },
  "type" : "capsuleCRM/v1/createContact"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Create Task

Name: createTask

Creates a new Task

Properties

NameLabelTypeDescriptionRequired
descriptionDescriptionSTRINGA short description of the task.true
dueOnDue DateDATEThe date when this task is due.true
detailDetailSTRINGMore details about the task.false
categoryCategoryOBJECT
Properties {STRING(name), STRING(colour)}
The category of this task.false

Example JSON Structure

{
  "label" : "Create Task",
  "name" : "createTask",
  "parameters" : {
    "description" : "",
    "dueOn" : "2021-01-01",
    "detail" : "",
    "category" : {
      "name" : "",
      "colour" : ""
    }
  },
  "type" : "capsuleCRM/v1/createTask"
}

Output

Type: OBJECT

Properties

NameTypeDescription
idINTEGERThe ID of the new task.
descriptionSTRINGThe description of the task.
dueOnDATEThe due date of the task.
detailSTRINGDetails of the new task.
categoryOBJECT
Properties {STRING(id), STRING(name), STRING(colour)}
The category of the new task.

Output Example

{
  "id" : 1,
  "description" : "",
  "dueOn" : "2021-01-01",
  "detail" : "",
  "category" : {
    "id" : "",
    "name" : "",
    "colour" : ""
  }
}

How is this guide?

Last updated on

On this page