---
canonical_url: "https://docs.composio.dev/toolkits/agile_crm"
markdown_url: "https://docs.composio.dev/toolkits/agile_crm.md"
product: "platform"
version: null
last_updated: null
---

# Agile CRM

Agile CRM combines contact management, sales pipelines, marketing automation, tasks, campaigns, and customer support in one platform.

- **Category:** crm
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `AGILE_CRM`
- **Version:** 00000000_00

## Tools

### Create Contact or Company

**Slug:** `AGILE_CRM_CREATE_CONTACT_OR_COMPANY`

Create a person contact with optional tags and scoring, or a company, with common and tenant custom properties.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Person first name for PERSON, or company name for COMPANY. |
| `tags` | array | No | PERSON-only tags. Each starts with a letter and contains only letters, numbers, underscores, hyphens, and spaces. Do not set for COMPANY. |
| `email` | string | No | Primary work email stored as a SYSTEM email property. |
| `phone` | string | No | Primary work phone stored as a SYSTEM phone property. |
| `last_name` | string | No | Person's last name. Valid only when resource_type is PERSON. |
| `lead_score` | integer | No | PERSON-only positive initial lead score. Do not set for COMPANY. |
| `star_value` | integer | No | PERSON-only initial star rating from 0 to 5. Do not set for COMPANY. |
| `resource_type` | string ("PERSON" | "COMPANY") | Yes | Whether to create a person contact or a company. |
| `custom_properties` | array | No | Additional tenant custom-field values. |
| `contact_company_id` | integer | No | Existing company ID to associate with a person. Valid only for PERSON. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Deal

**Slug:** `AGILE_CRM_CREATE_DEAL`

Create a deal, optionally associate contacts, and validate or resolve a case-sensitive milestone from the selected or default pipeline.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Deal name. |
| `owner_id` | integer | No | Agile CRM user ID that will own the deal. |
| `milestone` | string | No | Exact case-sensitive milestone name. Omit to use the first milestone from the selected or default pipeline. |
| `close_date` | integer | No | Expected close time as Unix epoch seconds. |
| `contact_ids` | array | No | Person or company IDs to associate with the deal. |
| `description` | string | No | Deal description. |
| `pipeline_id` | integer | No | Pipeline ID. Omit to use the tenant's default pipeline. |
| `probability` | integer | No | Win probability percentage from 0 to 100. |
| `custom_fields` | array | No | Deal custom-field values sent to Agile CRM as custom_data. |
| `expected_value` | number | Yes | Expected monetary value of the deal, up to 1,000,000,000,000. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Contact or Company

**Slug:** `AGILE_CRM_DELETE_CONTACT_OR_COMPANY`

Permanently delete one person contact or company by numeric ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `resource_id` | integer | Yes | Numeric ID of the person contact or company to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Deal

**Slug:** `AGILE_CRM_DELETE_DEAL`

Permanently delete one deal by its numeric Agile CRM ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `deal_id` | integer | Yes | Numeric ID of the deal to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact or Company

**Slug:** `AGILE_CRM_GET_CONTACT_OR_COMPANY`

Get one person contact or company by its numeric Agile CRM ID; return null when the resource does not exist.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `resource_id` | integer | Yes | Numeric ID of the person contact or company to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Deal

**Slug:** `AGILE_CRM_GET_DEAL`

Get one deal by its numeric Agile CRM ID; return null when the deal does not exist.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `deal_id` | integer | Yes | Numeric ID of the deal to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contacts

**Slug:** `AGILE_CRM_LIST_CONTACTS`

Return one creation-ordered page of person contacts, with a cursor for the next page when more contacts exist.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. |
| `page_size` | integer | No | Maximum contacts to request in this page; Agile CRM documents no upper bound. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Deals

**Slug:** `AGILE_CRM_LIST_DEALS`

Return one creation-ordered page of deals, with a cursor for the next page when more deals exist.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. |
| `page_size` | integer | No | Maximum deals to request in this page; Agile CRM documents no upper bound. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Contact or Company

**Slug:** `AGILE_CRM_UPDATE_CONTACT_OR_COMPANY`

Add or replace selected properties on one person contact or company without replacing properties that are not included.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `properties` | array | Yes | Properties to add or replace. Existing properties not included in this list remain unchanged. |
| `resource_id` | integer | Yes | Numeric ID of the person contact or company to update. This is sent to Agile CRM as id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Deal

**Slug:** `AGILE_CRM_UPDATE_DEAL`

Partially update selected fields of an existing deal without replacing fields that are not supplied.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Replacement deal name. |
| `deal_id` | integer | Yes | Numeric ID of the deal to update. This is sent to Agile CRM as id. |
| `milestone` | string | No | Replacement exact case-sensitive milestone name. |
| `close_date` | integer | No | Replacement expected close time as Unix epoch seconds. |
| `contact_ids` | array | No | Person or company IDs to add to the deal's existing associations. This partial-update operation cannot remove associations. |
| `description` | string | No | Replacement deal description. |
| `pipeline_id` | integer | No | Replacement pipeline ID. When milestone is omitted, the pipeline's first milestone is selected. |
| `probability` | integer | No | Replacement win probability percentage from 0 to 100. |
| `custom_fields` | array | No | Complete replacement set of deal custom-field values. This is sent to Agile CRM as custom_data. |
| `expected_value` | number | No | Replacement expected monetary value, up to 1,000,000,000,000. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |