Skip to main content

agilecrm-python

agilecrm is an API wrapper for Agile CRM written in Python

Installing

pip install agilecrm-python

Usage

from agilecrm.client import Client

client = Client('API_KEY', 'EMAIL', 'DOMAIN')

Create contact

contact_data = {
    "star_value": "4",
    "lead_score": "92",
    "tags": [
        "Lead",
        "Likely Buyer"
    ],
    "properties": [
        {
            "type": "SYSTEM",
            "name": "first_name",
            "value": "Los "
        },
        {
            "type": "SYSTEM",
            "name": "last_name",
            "value": "Bruikheilmer"
        },
        {
            "type": "SYSTEM",
            "name": "company",
            "value": "steady.inc"
        },
        {
            "type": "SYSTEM",
            "name": "title",
            "value": "VP Sales"
        },
        {
            "type": "SYSTEM",
            "name": "email",
            "subtype": "work",
            "value": "akrambakram@yabba.com"
        },
        {
            "type": "SYSTEM",
            "name": "address",
            "value": "{\"address\":\"225 George Street\",\"city\":\"NSW\",\"state\":\"Sydney\",\"zip\":\"2000\",\"country\":\"Australia\"}"
        },
        {
            "type": "CUSTOM",
            "name": "My Custom Field",
            "value": "Custom value"
        }
    ]
}

response = client.create_contact(contact_data)

Get contact by id

response = client.get_contact_by_id('5685265389584384')

Get contact by email

response = client.get_contact_by_email('akrambakram@yabba.com')

Update contact

update_contact_data = {
    "id": "5685265389584384",
    "properties": [
        {
            "type": "SYSTEM",
            "name": "last_name",
            "value": "Chan"
        },
        {
            "type": "CUSTOM",
            "name": "My Custom Field",
            "value": "Custom value chane"
        }
    ]
}
response = client.update_contact(update_contact_data)

Search contacts

import json

myjson = {
    "rules": [{"LHS": "created_time", "CONDITION": "BETWEEN", "RHS": 1510152185.779954, "RHS_NEW": 1510238585.779877}],
    "contact_type": "PERSON"}
    
response = client.search(
    {'page_size': 25,
    'global_sort_key': '-created_time',
    'filterJson': json.dumps(myjson)
})

Requirements

  • requests

Tests

python tests/test_client.py

Metadata

Release files for agilecrm-python 0.1.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for agilecrm-python 0.1.5
File Size Uploaded Provenance Actions
agilecrm_python-0.1.5.tar.gz 5.7 kB Without provenance Details for agilecrm_python-0.1.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for agilecrm-python 0.1.5
File Interpreter ABI Platform Actions
agilecrm_python-0.1.5-py3-none-any.whl Python 3 none any Details for agilecrm_python-0.1.5-py3-none-any.whl

Total release size: 12.2 kB

Release files / agilecrm_python-0.1.5.tar.gz

Download URL agilecrm_python-0.1.5.tar.gz
Size 5.7 kB
Tags Source
SHA-256 checksum
How to use checksums
a0c10b72311c18a57ff80c6b002ffce64aedd9bc3862f5939731a5591f957516
BLAKE2b-256 checksum
How to use checksums
4452ba6f1a89a3671d862f1e82d75ef16ff0c84d97b55e54b4ebb1588c223062
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.9

Release files / agilecrm_python-0.1.5-py3-none-any.whl

Download URL agilecrm_python-0.1.5-py3-none-any.whl
Size 6.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a9a7fb334fd19e94cbc7fdba3ca2704af566bb6b0c440136d6bb3b9b6e1a2775
BLAKE2b-256 checksum
How to use checksums
6de965ce171327fc2e29d702f9afbae44e92ed603444b48c563588c7241aee26
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.9

Security for agilecrm-python 0.1.5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page