ByteChef LogoByteChef
Components

ActiveCampaign

ActiveCampaign is a customer experience automation platform that offers email marketing, marketing automation, sales automation, and CRM tools.

Categories: CRM, Marketing Automation

Type: active-campaign/v1


Connections

Version: 1

API Key

Properties

NameLabelTypeDescriptionRequired
usernameAccount nameSTRINGYour account name, e.g. https://{youraccountname}.api-us1.comtrue
keyKeySTRINGtrue
valueAPI KeySTRINGtrue

Actions

Create Account

Name: createAccount

Creates a new account.

Properties

NameLabelTypeDescriptionRequired
accountAccountOBJECT
Properties {STRING(name), STRING(accountUrl)}
false

Example JSON Structure

{
  "label" : "Create Account",
  "name" : "createAccount",
  "parameters" : {
    "account" : {
      "name" : "",
      "accountUrl" : ""
    }
  },
  "type" : "active-campaign/v1/createAccount"
}

Output

Type: OBJECT

Properties

NameTypeDescription
accountOBJECT
Properties {STRING(name), STRING(accountUrl), STRING(id)}

Output Example

{
  "account" : {
    "name" : "",
    "accountUrl" : "",
    "id" : ""
  }
}

Create Contact

Name: createContact

Creates a new contact.

Properties

NameLabelTypeDescriptionRequired
contactContactOBJECT
Properties {STRING(email), STRING(firstName), STRING(lastName), STRING(phone)}
false

Example JSON Structure

{
  "label" : "Create Contact",
  "name" : "createContact",
  "parameters" : {
    "contact" : {
      "email" : "",
      "firstName" : "",
      "lastName" : "",
      "phone" : ""
    }
  },
  "type" : "active-campaign/v1/createContact"
}

Output

Type: OBJECT

Properties

NameTypeDescription
contactOBJECT
Properties {STRING(email), STRING(firstName), STRING(lastName), STRING(phone), STRING(id)}

Output Example

{
  "contact" : {
    "email" : "",
    "firstName" : "",
    "lastName" : "",
    "phone" : "",
    "id" : ""
  }
}

Create Task

Name: createTask

Creates a new task.

Properties

NameLabelTypeDescriptionRequired
dealTaskDeal TaskOBJECT
Properties {STRING(title), INTEGER(relid), DATE(duedate), INTEGER(dealTasktype)}
false

Example JSON Structure

{
  "label" : "Create Task",
  "name" : "createTask",
  "parameters" : {
    "dealTask" : {
      "title" : "",
      "relid" : 1,
      "duedate" : "2021-01-01",
      "dealTasktype" : 1
    }
  },
  "type" : "active-campaign/v1/createTask"
}

Output

Type: OBJECT

Properties

NameTypeDescription
dealTaskOBJECT
Properties {STRING(id), STRING(title), INTEGER(relid), DATE(duedate), INTEGER(dealTasktype)}

Output Example

{
  "dealTask" : {
    "id" : "",
    "title" : "",
    "relid" : 1,
    "duedate" : "2021-01-01",
    "dealTasktype" : 1
  }
}

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.