A python client for AgileCRM
Project description
Python library for Agile CRM based on the rest-api documentation.
Status
We use this in production for Screenly, and it works fine. Still a bit rough around the corners, but it does indeed work.
Installation
Clone the repo as a sub-module inside your project.
Install the Python requirements.
$ pip install agilecrm
Configuration
In order to use the module, you need to set the following environment variables:
AGILECRM_APIKEY
AGILECRM_EMAIL
AGILECRM_DOMAIN
Usage
First, you need to import the module. This may vary depending on your paths etc, but something like:
import agilecrm
Creating a user
Simply create a new user. Despite what is claimed in the documentation, all variables appear to be optional.
agilecrm.create_contact( first_name='John', last_name='Doe', email='john@doe.com', tags=['signed_up'], company='Foobar Inc')
You can also use custom fields (must be created in Agile CRM first):
agilecrm.create_contact( first_name='John', custom = { 'SomeField': 'Foobar' }
Update a contact
Update a user object.
agilecrm.update_contact( first_name='Steve', last_name='Smith', email='john@doe.com', tags=['name_updated'], company='Foobar2 Inc')
Get a user (by email)
This will get the user by email and return the user object as JSON.
agilecrm.get_contact_by_email('john@doe.com')
Get a user (by UUID)
This will get the user by UUID and return the user object as JSON.
agilecrm.get_contact_by_uuid(1234)
Add a tag
This will add the tag ‘awesome_user’ to the user ‘john@doe.com’. Both variables are required.
agilecrm.add_tag('john@doe.com', 'awesome_user')
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for agilecrm-0.0.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 69192be85be995da73d3d48355b03f30e72d552e92b5851c0bf03dd7a0cd8beb |
|
MD5 | f7d585de498c395196a365d66c885892 |
|
BLAKE2b-256 | c5cab4e0f532784ba470e9c4daef33975edbcbea522aa8f628967682e9ed7f7b |