https://github.com/dissfall/active-campaign-v1

Wrapper for Active Campaign API v1
https://github.com/dissfall/active-campaign-v1

active-campaign api api-wrapper wrapper

Last synced: 2 months ago
JSON representation

Wrapper for Active Campaign API v1

• Host: GitHub
• URL: https://github.com/dissfall/active-campaign-v1
• Owner: Dissfall
• License: mit
• Created: 2020-02-05T10:39:30.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-05-11T11:57:46.000Z (about 5 years ago)
• Last Synced: 2024-05-02T04:18:23.440Z (about 2 years ago)
• Topics: active-campaign, api, api-wrapper, wrapper
• Language: TypeScript
• Size: 1.28 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# active-campaign-v1

_Wrapper for Active Campaign API v1_

[![NPM](https://nodei.co/npm/active-campaign-v1.png?downloads=true&downloadRank=true)](https://nodei.co/npm/active-campaign-v1/)

[![npm Downloads](https://img.shields.io/npm/dm/active-campaign-v1.svg?style=flat-square)](https://npmcharts.com/compare/active-campaign-v1?minimal=true)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](http://commitizen.github.io/cz-cli/)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square&logo=prettier)](https://github.com/prettier/prettier)

This module contains API endpoints, which I needed when implementing my project. You can easily contribute to this module the endpoints you need and use them.

## Installation

```BASH

yarn add active-campaign-v1

```

**or**

```BASH

npm install active-campaign-v1

```

## Docks

**See the documentation at []()**

## Example

### Common JS

```JS

import { AC } from 'active-campaign-v1'

const ac = new AC('', '')

ac.contactAdd({

    email: 'test@mail.com',

    firstName: 'test'

  })

```

This code creates new contact with email `test@mail.com` and `test` name.

## Avaliable methods

### Account view

_full support_

|   endpoint   |    method   |

|     ----     |     ----    |

| account_view | accountView |

### Contact

_partially support_

|   endpoint   |    method   |

|     ----     |     ----    |

| contact_add  | contactAdd  |

| contact_sync | contactSync |

| contact_view | contactView |

## License

Licensed under the MIT License, Copyright © 2020-present George Lukyanov

See LICENSE for more information.