Encharge
Encharge is a marketing automation platform that helps businesses automate their customer communication and marketing campaigns.
Categories: Marketing Automation
Type: encharge/v1
Connections
Version: 1
API Key
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| key | Key | STRING | true | |
| value | Value | STRING | true |
Connection Setup
- Login to your Encharge dashboard.
- Click on your profile icon in the top right corner and select Your Account.
- Copy API Key and use it in ByteChef.
Actions
Add Tag
Name: addTag
Add tag(s) to an existing user.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| tag | Tag | STRING | Tag(s) to add. To add multiple tags, use a comma-separated list, e.g. tag1,tag2 | true |
| STRING | Email of the person. | true |
Example JSON Structure
{
"label" : "Add Tag",
"name" : "addTag",
"parameters" : {
"tag" : "",
"email" : ""
},
"type" : "encharge/v1/addTag"
}Output
This action does not produce any output.
Create Email Template
Name: createEmail
Create email template
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| name | Name | STRING | Name of the email template | true |
| subject | Subject | STRING | Subject of the email | true |
| fromEmail | From Email | STRING | From address to send the email from | true |
| replyEmail | Reply Email | STRING | Address that recipients will reply to by default. | false |
Example JSON Structure
{
"label" : "Create Email Template",
"name" : "createEmail",
"parameters" : {
"name" : "",
"subject" : "",
"fromEmail" : "",
"replyEmail" : ""
},
"type" : "encharge/v1/createEmail"
}Output
Type: OBJECT
Properties
| Name | Type | Description |
|---|---|---|
OBJECT Properties{INTEGER(id), STRING(name), STRING(subject), STRING(fromEmail), STRING(replyEmail)} |
Output Example
{
"email" : {
"id" : 1,
"name" : "",
"subject" : "",
"fromEmail" : "",
"replyEmail" : ""
}
}Create People
Name: createPeople
Creates new People
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| people | People | ARRAY Items[{STRING(email), STRING(firstName), STRING(lastName), STRING(website), STRING(title), STRING(phone)}] | true |
Example JSON Structure
{
"label" : "Create People",
"name" : "createPeople",
"parameters" : {
"people" : [ {
"email" : "",
"firstName" : "",
"lastName" : "",
"website" : "",
"title" : "",
"phone" : ""
} ]
},
"type" : "encharge/v1/createPeople"
}Output
Type: OBJECT
Properties
| Name | Type | Description |
|---|---|---|
| users | ARRAY Items[{STRING(email), STRING(firstName), STRING(lastName), STRING(website), STRING(title), STRING(id), STRING(phone)}] |
Output Example
{
"users" : [ {
"email" : "",
"firstName" : "",
"lastName" : "",
"website" : "",
"title" : "",
"id" : "",
"phone" : ""
} ]
}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.
How is this guide?
Last updated on