Ballerina library

activecampaign

Module activecampaign

OverviewPrerequisitesQuickstart

API

Client

Definitions

Account
AccountData
AccountdataAccount
AccountListResponse
AccountNoteData
AddContactAutomationRequest
AddTagToContactRequest
ApiKeysConfig
Batch
BounceLog
BounceLogResponse
BulkContactData
BulkImportRequest
BulkImportResponse
BulkImportStatus
BulkImportStatusInfo
CampaignData
CampaignListResponse
CampaignReadResponse
ClientHttp1Settings
ConnectionConfig
Contact
ContactAutomation
ContactAutomationData
ContactAutomationListResponse
ContactAutomationResponse
ContactData
ContactDataResponse
ContactGoal
ContactGoalResponse
ContactList
ContactListData
ContactListListResponse
ContactListResponse
ContactRead
ContactReadResponse
ContactTag
ContactTagData
ContactTagReadResponse
CreateAccountNoteRequest
CreateAccountRequest
CreateContactRequest
CreateListRequest
Deal
Field
FieldValue
GeoAddress
GeoIp
LinksList
ListCreateResponse
ListData
ListListResponse
ListReadResponse
MessageData
MessageListResponse
MessageReadResponse
Meta
MetaPageInput
NoteData
NotedataNote
NotedataNoteLinksNotedataNoteOwner
ProxyConfig
Subscribe
SubscribeOrUnsubscribeContactRequest
SubscribeOrUnsubscribeContactResponse
UpdatableAccount
UpdateAccountNoteRequest
UpdateAccountRequest
UpdateContactData
UpdateContactRequest

ballerinax/activecampaign Ballerina library

1.3.1

Overview

This is a generated connector for ActiveCampaign API v3 OpenAPI specification.

ActiveCampaign is an integrated email marketing, automation, sales software, and CRM platform. It lets users perform powerful automation, email marketing, and customer relationship management.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Quickstart

To use the ActiveCampaign connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

First, import the ballerinax/activecampaign module into the Ballerina project.

Copy
import ballerinax/activecampaign;

Step 2: Create a new connector instance

You can now make the connection configuration using the <API_TOKEN>.

Copy
activecampaign:ApiKeysConfig apiKeyConfig = {
    apiToken:"<API_TOKEN>"
};

activecampaign:Client baseClient = check new (clientConfig);

Step 3: Invoke connector operation

Now you can use the operations available within the connector. Note that they are in the form of remote operations.

Following is an example to list contacts using the connector.

Copy
public function main() {
    activecampaign:AccountListResponse|error result = baseClient->listAccounts();
    if (result is activecampaign:AccountListResponse) {
        log:printInfo(result.toString());
    } else {
        log:printInfo(result.toString());
    }
}
  1. Use bal run command to compile and run the Ballerina program.

Clients

activecampaign: Client

Isolated

This is a generated connector for ActiveCampaign API version 3 OpenAPI specification. ActiveCampaignis an integrated email marketing, automation, sales software, and CRM platform. It lets users perform powerful automation, email marketing, and customer relationship management.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create an ActiveCampaign account and obtain tokens by following this guide.

init (ApiKeysConfig apiKeyConfig, string serviceUrl, ConnectionConfig config)
  • serviceUrl string - URL of the target service
  • config ConnectionConfig {} - The configurations to be used when initializing the connector

retrieveAccount

Isolated FunctionRemote Function
function retrieveAccount(string id) returns AccountData|error

Retrieve an account

Parameters
Return Type

updateAccount

Isolated FunctionRemote Function
function updateAccount(string id, UpdateAccountRequest payload) returns AccountData|error

Update an account

Parameters
Return Type

deleteAccount

Isolated FunctionRemote Function
function deleteAccount(string id) returns Response|error

Delete an account

Parameters
Return Type

listAccounts

Isolated FunctionRemote Function
function listAccounts(string? search, string? countDeals) returns AccountListResponse|error

List all accounts

Parameters
  • search string? (default ()) - Search by name
  • countDeals string? (default ()) - Whether to compute the contactCount and dealCount counts for the number of contacts/deals associated with each account. Set it to true to include the right counts. If set to false or omitted from the call, then contactCount and dealCount will not be counted and be simply displayed as 0.
Return Type

createAccount

Isolated FunctionRemote Function
function createAccount(CreateAccountRequest payload) returns AccountData|error

Create an account

Parameters
Return Type

createAccountNote

Isolated FunctionRemote Function
function createAccountNote(string id, CreateAccountNoteRequest payload) returns AccountNoteData|error

Create a new note for an account

Parameters
  • id string - Account's id to assign new note to
Return Type

updateAccoutNote

Isolated FunctionRemote Function
function updateAccoutNote(string id, string noteId, UpdateAccountNoteRequest payload) returns AccountNoteData|error

Update an account note

Parameters
  • id string - Account's id to assign new note to
  • noteId string - Account note's id to update
Return Type

getContacts

Isolated FunctionRemote Function
function getContacts(string? ids, string? email, string? emailLike, int? exclude, int? formid, int? idGreater, int? idLess, string? listid, string? search, int? segmentid, int? seriesid, int? status, int? tagid, string? filtersCreatedBefore, string? filtersCreatedAfter, string? filtersUpdatedBefore, string? filtersUpdatedAfter, int? waitid, string? ordersCdate, string? ordersEmail, string? ordersFirstName, string? ordersLastName, string? ordersName, string? fordersScore, string? inGroupLists) returns ContactListResponse|error

List, search, and filter contacts

Parameters
  • ids string? (default ()) - Filter contacts by ID. Can be repeated for multiple IDs.
  • email string? (default ()) - Filter contacts by ID. Can be repeated for multiple IDs.
  • emailLike string? (default ()) - Filter contacts that contain the given value in the email address
  • exclude int? (default ()) - Exclude from the response the contact with the given ID
  • formid int? (default ()) - Filter contacts associated with the given form
  • idGreater int? (default ()) - Only include contacts with an ID greater than the given ID
  • idLess int? (default ()) - Only include contacts with an ID less than the given ID
  • listid string? (default ()) - Filter contacts associated with the given list
  • search string? (default ()) - Filter contacts that match the given value in the contact names, organization, phone or email
  • segmentid int? (default ()) - Return only contacts that match a list segment (this param initially returns segment information, when it is run a second time it will return contacts that match the segment)
  • seriesid int? (default ()) - Filter contacts associated with the given automation
  • status int? (default ()) - Status
  • tagid int? (default ()) - Filter contacts associated with the given tag
  • filtersCreatedBefore string? (default ()) - Filter contacts that were created prior to this date
  • filtersCreatedAfter string? (default ()) - Filter contacts that were created after this date
  • filtersUpdatedBefore string? (default ()) - Filter contacts that were updated before this date
  • filtersUpdatedAfter string? (default ()) - Filter contacts that were updated after this date
  • waitid int? (default ()) - Filter by contacts in the wait queue of an automation block
  • ordersCdate string? (default ()) - Order contacts by creation date
  • ordersEmail string? (default ()) - Order contacts by email
  • ordersFirstName string? (default ()) - Order contacts by first name
  • ordersLastName string? (default ()) - Order contacts by last name
  • ordersName string? (default ()) - Order contacts by full name
  • fordersScore string? (default ()) - Order contacts by score
  • inGroupLists string? (default ()) - Set this to "true" in order to return only contacts that the current user has permissions to see.
Return Type

createContact

Isolated FunctionRemote Function
function createContact(CreateContactRequest payload) returns ContactReadResponse|error

Create Contact

Parameters
Return Type

getContactById

Isolated FunctionRemote Function
function getContactById(string contactId) returns ContactReadResponse|error

Retrieve an existing contact

Parameters
  • contactId string - ID of the contact
Return Type

deleteContact

Isolated FunctionRemote Function
function deleteContact(int contactId) returns Response|error

Delete Contact

Parameters
  • contactId int - Delete an existing contact
Return Type

getContactData

Isolated FunctionRemote Function
function getContactData(int contactId) returns ContactDataResponse|error

Retrieve a contact's data

Parameters
  • contactId int - ID of the contact
Return Type

getContactBounceLogs

Isolated FunctionRemote Function
function getContactBounceLogs(int contactId) returns BounceLogResponse|error

Get Contact Bounce Logs

Parameters
  • contactId int - ID of the contact
Return Type

getContactDataGoals

Isolated FunctionRemote Function
function getContactDataGoals(int contactId) returns ContactGoalResponse|error

Retrieve a contact's goals

Parameters
  • contactId int - ID of the contact
Return Type

listContactAutomations

Isolated FunctionRemote Function
function listContactAutomations() returns ContactAutomationListResponse|error

List all automations a contact is in

Return Type

addContactToAutomation

Isolated FunctionRemote Function
function addContactToAutomation(AddContactAutomationRequest payload) returns ContactAutomationResponse|error

Add a contact to an automation

Parameters
Return Type

getContactAutomation

Isolated FunctionRemote Function
function getContactAutomation(int contactAutomationId) returns ContactAutomationResponse|error

Retrieve an automation a contact is in

Parameters
  • contactAutomationId int - ID of the contactAutomation to retrieve
Return Type

deleteContactAutomation

Isolated FunctionRemote Function
function deleteContactAutomation(int contactAutomationId) returns Response|error

Remove a contact from an automation

Parameters
  • contactAutomationId int - ID of the contactAutomation to delete
Return Type

listEmailActivities

Isolated FunctionRemote Function
function listEmailActivities(int filtersSubscriberid, int filtersDealid) returns json|error

List all email activities

Parameters
  • filtersSubscriberid int - Set this parameter to return only email activities belonging to a given subscriber.
  • filtersDealid int - Set this parameter to return only email activities belonging to a given deal.
Return Type
  • json|error - Email Activities

createOrUpdateContact

Isolated FunctionRemote Function
function createOrUpdateContact(UpdateContactRequest payload) returns ContactReadResponse|error

Create or update a contact

Parameters
Return Type

subscribeOrUnsubscribeContactFromList

Isolated FunctionRemote Function
function subscribeOrUnsubscribeContactFromList(SubscribeOrUnsubscribeContactRequest payload) returns SubscribeOrUnsubscribeContactResponse|error

Subscribe a contact to a list or unsubscribe a contact from a list.

Parameters
Return Type

bulkImportStatusList

Isolated FunctionRemote Function
function bulkImportStatusList() returns BulkImportStatus|error

Bulk import status list. After using the POST endpoint to send bulk data, you can use this endpoint to monitor progress.

Return Type

bulkImportContacts

Isolated FunctionRemote Function
function bulkImportContacts(BulkImportRequest payload) returns BulkImportResponse|error

Bulk import contacts

Parameters
Return Type

bulkImportStatusInfo

Isolated FunctionRemote Function
function bulkImportStatusInfo(string batchId) returns BulkImportStatusInfo|error

This endpoint returns a specific bulk import's status including the contact IDs of any newly created contacts, and emails of any contacts that failed to be created.

Parameters
Return Type

getCampaigns

Isolated FunctionRemote Function
function getCampaigns(string? ordersSdate, string? ordersLdate, string? filtersAutomation) returns CampaignListResponse|error

List all campaigns

Parameters
  • ordersSdate string? (default ()) - Order campaigns by send date
  • ordersLdate string? (default ()) - Order campaigns by last send date
  • filtersAutomation string? (default ()) - Filter to return automation campaigns
Return Type

getCampaignById

Isolated FunctionRemote Function
function getCampaignById(int campaignId) returns CampaignReadResponse|error

Retrieve a campaign

Parameters
  • campaignId int - ID of campaign to retrieve
Return Type

getMessages

Isolated FunctionRemote Function
function getMessages() returns MessageListResponse|error

List all messages

Return Type

addTagToContact

Isolated FunctionRemote Function
function addTagToContact(AddTagToContactRequest payload) returns ContactTagReadResponse|error

Add a tag to a contact

Parameters
Return Type

removeTagFromContact

Isolated FunctionRemote Function
function removeTagFromContact(string tagId) returns Response|error

Remove a tag from a contact

Parameters
  • tagId string - The contactTag id
Return Type

getLists

Isolated FunctionRemote Function
function getLists(string? filtersName) returns ListListResponse|error

Retrieve all lists

Parameters
  • filtersName string? (default ()) - Filter by the name of the list
Return Type

createList

Isolated FunctionRemote Function
function createList(CreateListRequest payload) returns ListCreateResponse|error

Create a list

Parameters
Return Type

Records

activecampaign: Account

Fields
  • accountUrl string? - Account's website
  • fields Field[]? - Account's custom field values {customFieldId- int, fieldValue- string, fieldCurrency?-string}[]

activecampaign: AccountData

Fields

activecampaign: AccountdataAccount

Fields

activecampaign: AccountListResponse

Fields

activecampaign: AccountNoteData

Fields

activecampaign: AddContactAutomationRequest

Fields

activecampaign: AddTagToContactRequest

Fields

activecampaign: ApiKeysConfig

Closed record

Provides API key configurations needed when communicating with a remote HTTP endpoint.

Fields
  • apiToken string - Provide your API Key as Api-Token. Eg: {apiToken : <Your API Key>} Your API key can be found in your account on the Settings page under the Developer tab.

activecampaign: Batch

Fields

activecampaign: BounceLog

Fields

activecampaign: BounceLogResponse

Fields

activecampaign: BulkContactData

Fields
  • email string - The contact's email.
  • first_name string? - The contact's first name
  • last_name string? - The contact's last name.
  • phone string? - The contact’s phone number.
  • customer_acct_name string? - The name of the contact’s account.
  • tags string[]? - Each string in the array will be added as a single tag to the contact. New tags will be created if they do not already exist.
  • fields FieldValue[]? - A list of custom fields to apply to the contact. Each field must contain two fields- Each contact may have up to N custom fields.
  • subscribe Subscribe[]? - An array of lists to subscribe the contact to. Contacts may not be subscribed to lists which they have previously unsubscribed from. Each list object contains a single field.
  • unsubscribe Subscribe[]? - An array of lists to unsubscribe the contact to. Each list object contains a single field.

activecampaign: BulkImportRequest

Fields

activecampaign: BulkImportResponse

Fields
  • Success int? -
  • queued_contacts int? -

activecampaign: BulkImportStatus

Fields
  • recentlyCompleted Batch[]? -

activecampaign: BulkImportStatusInfo

Fields

activecampaign: CampaignData

Fields
  • tracklinksanalytics string? -
  • trackreadsanalytics string? -
  • analytics_campaign_name string? -
  • split_winner_messageid string? -
  • split_winner_awaiting string? -
  • reminder_offset_type string? -
  • reminder_offset_sign string? -
  • reminder_last_cron_run string? -

activecampaign: CampaignListResponse

Fields

activecampaign: CampaignReadResponse

Fields

activecampaign: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields
  • keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
  • chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

activecampaign: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields
  • httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
  • timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
  • forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header
  • cache CacheConfig? - HTTP caching related configurations
  • compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header
  • circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
  • retryConfig RetryConfig? - Configurations associated with retrying
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

activecampaign: Contact

Fields
  • email string - Email address of the new contact. Example- 'test@example.com'
  • firstName string? - First name of the new contact.
  • lastName string? - Last name of the new contact.
  • phone int? - Phone number of the contact.

activecampaign: ContactAutomation

Fields
  • contact string? - Contact ID of the Contact, to be linked to the contactAutomation
  • automation string? - Automation ID of the automation, to be linked to the contactAutomation

activecampaign: ContactAutomationData

Fields
  • completed int? -
  • completeValue int? -

activecampaign: ContactAutomationListResponse

Fields

activecampaign: ContactAutomationResponse

Fields

activecampaign: ContactData

Fields
  • ga_campaign_content string? -
  • ga_campaign_customsegment string? -

activecampaign: ContactDataResponse

Fields

activecampaign: ContactGoal

Fields

activecampaign: ContactGoalResponse

Fields

activecampaign: ContactList

Fields
  • unsubscribeAutomation string? -

activecampaign: ContactListData

Fields
  • list int - ID of the list to subscribe the contact to
  • contact int - ID of the contact to subscribe to the list
  • status int - Set to "1" to subscribe the contact to the list. Set to "2" to unsubscribe the contact from the list. WARNING- If you change a status from unsubscribed to active, you can re-subscribe a contact to a list from which they had manually unsubscribed.
  • sourceid int? - Set to "4" when re-subscribing a contact to a list

activecampaign: ContactListListResponse

Fields

activecampaign: ContactListResponse

Fields
  • scoreValues anydata[]? -

activecampaign: ContactRead

Fields
  • socialdata_lastcheck string? -
  • scoreValues anydata[]? -

activecampaign: ContactReadResponse

Fields

activecampaign: ContactTag

Fields
  • contact string? - The id of the Contact
  • tag string? - The id of the tag

activecampaign: ContactTagData

Fields

activecampaign: ContactTagReadResponse

Fields

activecampaign: CreateAccountNoteRequest

Fields
  • note string - Account note's content

activecampaign: CreateAccountRequest

Fields

activecampaign: CreateContactRequest

Fields

activecampaign: CreateListRequest

Fields

activecampaign: Deal

Fields

activecampaign: Field

Fields
  • customFieldId int - Field ID, ID of the Custom Field Meta Data
  • fieldValue string|int - Updated field value. For currency field, this needs to be in cents not dollars (or 100 x Base Unit).
  • fieldCurrency string? - Required only for the currency field type. The three letter currency code for the currency value

activecampaign: FieldValue

Fields
  • value string - Value related to field name

activecampaign: GeoAddress

Fields

activecampaign: GeoIp

Fields
Fields

activecampaign: List

Fields
  • name string - Name of the list to create
  • stringid string - URL-safe list name. Example- 'list-name-sample'
  • sender_url string - The website URL this list is for.
  • sender_reminder string - A reminder for your contacts as to why they are on this list and you are messaging them.
  • user int? - User Id of the list owner. A list owner is able to control campaign branding. A property of list. userid also exists on this object; both properties map to the same list owner field and are being maintained in the response object for backward compatibility. If you post values for both list.user and list.userid, the value of list.user will be used.
  • send_last_broadcast boolean? - Boolean value indicating whether or not to send the last sent campaign to this list to a new subscriber upon subscribing. 1 = yes, 0 = no
  • carboncopy string? - Comma-separated list of email addresses to send a copy of all mailings to upon send
  • subscription_notify string? - Comma-separated list of email addresses to notify when a new subscriber joins this list.
  • unsubscription_notify string? - Comma-separated list of email addresses to notify when a subscriber unsubscribes from this list.

activecampaign: ListCreateResponse

Fields

activecampaign: ListData

Fields
  • p_use_analytics_read string? -
  • send_last_broadcast string? -
  • twitter_token_secret string? -
  • subscription_notify string? -
  • unsubscription_notify string? -
  • get_unsubscribe_reason string? -

activecampaign: ListListResponse

Fields

activecampaign: ListReadResponse

Fields

activecampaign: MessageData

Fields

activecampaign: MessageListResponse

Fields

activecampaign: MessageReadResponse

Fields

activecampaign: Meta

Fields

activecampaign: MetaPageInput

Fields
  • segmentid int? -
  • seriesid int? -
  • forceQuery int? -

activecampaign: NoteData

Fields

activecampaign: NotedataNote

Fields
  • relid record {}? -
  • reltype record {}? -
  • user record {}? -
  • userid record {}? -
Fields

activecampaign: NotedataNoteOwner

Fields

activecampaign: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields
  • host string(default "") - Host name of the proxy server
  • port int(default 0) - Proxy server port
  • userName string(default "") - Proxy server username
  • password string(default "") - Proxy server password

activecampaign: Subscribe

Fields
  • listid string - The ID of the list to subscribe the contact to or unsubscribe the contact from. Lists must be referenced by the ID that ActiveCampaign assigns to them. You can find the list ID by clicking the list in your ActiveCampaign account then viewing the URL bar. It will look something like this- /app/contacts/?listid=19&status=1 You can also retrieve the ID number for a list by using the "Retrieve all lists" API call.

activecampaign: SubscribeOrUnsubscribeContactRequest

Fields

activecampaign: SubscribeOrUnsubscribeContactResponse

Fields

activecampaign: UpdatableAccount

Fields
  • accountUrl string? - Account's website
  • fields Field[]? - Account's custom field values {customFieldId- int, fieldValue- string, fieldCurrency?-string}[]

activecampaign: UpdateAccountNoteRequest

Fields
  • note string? - Account note's content

activecampaign: UpdateAccountRequest

Fields

activecampaign: UpdateContactData

Fields
  • email string? - Email address of the contact to sync
  • firstName string? - First name of the new contact.
  • lastName string? - Last name of the new contact.
  • phone int? - Phone number of the contact.
  • fieldValues FieldValue[]? - Contact's custom field values [{field, value}]

activecampaign: UpdateContactRequest

Fields

Import

import ballerinax/activecampaign;Copy

Metadata

Released date: 12 months ago

Version: 1.3.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 1248

Current verison: 247

Weekly downloads

Source repository

Keywords

Marketing/Marketing Automation

Cost/Freemium

Contributors

Other versions

1.3.1

1.3.01.2.01.0.0

Dependencies

ballerina/url/2.2.3ballerina/http/2.6.1

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2024 WSO2 LLC