Python library for AgileCRM API

rahmonov, updated 🕥 2022-01-21 18:58:28

Agile CRM

A Python interface for the Agile CRM API.

Installation

$ pip install agile-crm-python

Usage

In [1]: from agilecrm import AgileCRM

In [2]: EMAIL = 'your_email'
   ...: API_KEY = 'agilecrm_api_key'
   ...: DOMAIN = 'your_domain'

In [3]: agile_client = AgileCRM(DOMAIN, EMAIL, API_KEY)

In [4]: print(agile_client.contact.fetch('5649050225344512'))
{'data': {'klout_score': '', 'is_duplicate_existed': False, 'properties': [{'type': 'SYSTEM', 'value': 'Baqsssaasdf2', 'name': 'first_name'}, {'type': 'SYSTEM', 'value': 'SomeCompany', 'name': 'company'}, {'type': 'SYSTEM', 'value': '+998934979894', 'name': 'phone'}, {'type': 'CUSTOM', 'value': 'SuperSource', 'name': 'Captured Source'}, {'type': 'SYSTEM', 'value': '[email protected]', 'name': 'email'}], 'star_value': 4, 'created_time': 1498828722, 'lead_status_id': 0, 'last_emailed': 0, 'owner': {'email': '[email protected]', 'calendar_url': 'https://jahongir.agilecrm.com/calendar/Jahongir_Rahmonov', 'phone': '', 'id': 4840599839309824, 'calendarURL': 'https://jahongir.agilecrm.com/calendar/Jahongir_Rahmonov', 'name': 'Jahongir Rahmonov', 'pic': 'https://d1gwclp1pmzk26.cloudfront.net/img/gravatar/48.png', 'domain': 'jahongir', 'schedule_id': 'Jahongir_Rahmonov'}, 'entity_type': 'contact_entity', 'lead_score': 34, 'lead_converted_time': 0, 'browserId': [], 'id': 5649050225344512, 'is_lead_converted': False, 'updated_time': 1498854662, 'tags': ['ios', 'awesome'], 'is_client_import': False, 'last_called': 0, 'trashed_time': 0, 'type': 'PERSON', 'source': 'api', 'lead_source_id': 0, 'unsubscribeStatus': [], 'restored_time': 0, 'contact_company_id': '5714163003293696', 'tagsWithTime': [{'entity_type': 'tag', 'availableCount': 0, 'createdTime': 1498829643106, 'tag': 'ios'}, {'entity_type': 'tag', 'availableCount': 0, 'createdTime': 1498830015686, 'tag': 'awesome'}], 'emailBounceStatus': [], 'last_contacted': 0, 'is_duplicate_verification_failed': False, 'viewed': {'viewed_time': 1500654861002, 'viewer_id': 4840599839309824}, 'formId': 0, 'campaignStatus': [], 'viewed_time': 0, 'last_campaign_emaild': 0}, 'text': None, 'ok': True, 'status_code': 200}

Documentation

1 Contact * 1 Create a contact * 2 Fetch a contact by ID * 3 Delete a contact by ID * 4 Update a contact by ID * 5 Set a lead score for a contact * 6 Set a star value for a contact * 7 Add a tag to a contact * 8 Remove a tag from a contact * 9 Search for a contact * 10 Add a note to a contact * 11 Get notes of a contact * 12 Delete a note of a contact

2 Company * 1 Create a company * 2 Fetch a company by ID * 3 Update a company by ID * 4 Delete a company by ID

3 Deal * 1 Create a dea * 2 Update a deal by ID * 2 Fetch a deal by ID * 4 Delete a deal by ID
* 5 Get notes of a deal
* 6 Add notes to a deal
* 7 Update note of a deal

All the following examples assume that you have agile_client configured as shown above

1. Contact

1.1 Create a 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": "email",
            "subtype": "work",
            "value": "[email protected]"
        },
        {
            "type": "CUSTOM",
            "name": "My Custom Field",
            "value": "Custom value"
        }
    ]
}

response = agile_client.contact.create(contact_data)

1.2 Fetch a contact by id

response = agile_client.contact.fetch('5649050225344512')

1.3 Delete a contact by id

response = agile_client.contact.delete('5649050225344512')

1.4 Update a contact by id

new_contact_data = {
    "properties": [
        {
            "type": "SYSTEM",
            "name": "last_name",
            "value": "Chan"
        },
        {
            "type": "CUSTOM",
            "name": "My Custom Field",
            "value": "Custom value change"
        }
    ]
}

response = agile_client.contact.update('5689413791121408', new_contact_data)

1.5 Set a lead score for a contact

response = agile_client.contact.set_lead_score(contact_id='5689413791121408', lead_score=100)

1.6 Set a star value for a contact

response = agile_client.contact.set_star_value(contact_id='5689413791121408', star_value=3)

1.7 Add a tag to a contact

response = agile_client.contact.set_tags(contact_id='5689413791121408', tags=['new_tag'])

1.8 Remove a tag from a contact

response = agile_client.contact.remove_tags(contact_id='5689413791121408', tags_to_remove=['new_tag'])

1.9 Search for a contact

response = agile_client.contact.find(q='los', page_size=15)

1.10 Add a note to a contact

response = agile_client.contact.add_notes(contact_id='5689413791121408', subject='Note Subject', description='Some Note')

1.11 Get notes of a contact

response = agile_client.contact.get_notes(contact_id='5689413791121408')

1.12 Delete a note of a contact

respose = agile_client.contact.delete_note(contact_id='5689413791121408', note_id='5755685136498688')

2. Company

2.1 Create a company

company_data = {
    "type": "COMPANY",
    "star_value": 4,
    "lead_score": 120,
    "tags": [
        "Permanent",
        "USA",
    ],
    "properties": [
        {
            "name": "Company Type",
            "type": "CUSTOM",
            "value": "MNC Inc"
        },
        {
            "type": "SYSTEM",
            "name": "name",
            "value": "Spicejet"
        },
        {
            "type": "SYSTEM",
            "name": "url",
            "value": "http://www.spicejet.com/"
        },
        {
            "name": "email",
            "value": "[email protected]  ",
            "subtype": ""
        },
        {
            "name": "phone",
            "value": "45500000",
            "subtype": ""
        },
        {
            "name": "website",
            "value": "http://www.linkedin.com/company/agile-crm",
            "subtype": "LINKEDIN"
        },
        {
            "name": "address",
            "value": "{\"address\":\"MS 35, 440 N Wolfe Road\",\"city\":\"Sunnyvale\",\"state\":\"CA\",\"zip\":\"94085\",\"country\":\"US\"}",
            "subtype": "office"
        }
    ]
}

response = agile_client.company.create(company_data)

2.2 Fetch a company by id

respose = agile_client.company.fetch('5712536552865792')

2.3 Update a company by id

new_company_data = {
    "properties": [
        {
            "type": "SYSTEM",
            "name": "name",
            "value": "SPICE JET"
        },
        {
            "type": "SYSTEM",
            "name": "url",
            "value": "http://www.spicejet.com/"
        },
        {
            "name": "phone",
            "value": "45500000",
            "subtype": ""
        }
    ]
}

response = agile_client.company.update('5712536552865792', new_company_data)

2.4 Delete a company by id

response = agile_client.company.delete('5712536552865792')

3. Deal

3.1 Create a deal

Issues

Bump ipython from 6.1.0 to 7.16.3

opened on 2022-01-21 18:58:28 by dependabot[bot]

Bumps ipython from 6.1.0 to 7.16.3.

Commits

d43c7c7 release 7.16.3
5fa1e40 Merge pull request from GHSA-pq7m-3gw7-gq5x
8df8971 back to dev
9f477b7 release 7.16.2
138f266 bring back release helper from master branch
5aa3634 Merge pull request #13341 from meeseeksmachine/auto-backport-of-pr-13335-on-7...
bcae8e0 Backport PR #13335: What's new 7.16.2
8fcdcd3 Pin Jedi to <0.17.2.
2486838 release 7.16.1
20bdc6f fix conda build
Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) - `@dependabot use these labels` will set the current labels as the default for future PRs for this repo and language - `@dependabot use these reviewers` will set the current reviewers as the default for future PRs for this repo and language - `@dependabot use these assignees` will set the current assignees as the default for future PRs for this repo and language - `@dependabot use this milestone` will set the current milestone as the default for future PRs for this repo and language You can disable automated security fix PRs for this repo from the [Security Alerts page](https://github.com/rahmonov/agile-crm-python/network/alerts).

Add documentation in README

opened on 2017-07-21 16:49:22 by rahmonov None

Add comments to classes and methods

opened on 2017-06-30 19:58:07 by rahmonov None

Jahongir

Software Engineer

GitHub Repository

python agile-crm api api-wrapper