Agile CRM is a new breed CRM software with sales and marketing automation.
- Contact & companie fields
- Properties JSON
- Contact JSON example
- Properties JSON Complete Example
- Contact APIs
- 1 Listing contacts
- 2 Get contact by ID
- 3 Creating a contact
- 4 Updating contact
- 5 Update lead score by ID
- 6 Update star value by ID
- 7 Update tags value by ID
- 8 Delete tags value by ID
- 9 Delete single contact
- 10 Search contact by email
- 11 Search contacts/companies
- 12 Adding tags to a contact based on email
- 13 Delete tags to a contact based on email
- 14 Add score to a contact using email ID
- 15 Get tasks related to contact
- 16 Updating contact properties by Email
- 17 Change contact owner
- 18 Add contact to a campaign
- 19 Remove contact from a campaign
- 20 Get contact by phone number
- 21 Get contacts by dynamic filter
- Company APIs
- Deal fields
- Deal JSON Example
- Deal APIs
- 1 Listing deals
- 2 Get deal by its ID
- 3 Create deal
- 4 Partial update
- 5 Create deal to a contact using email ID
- 6 Delete deal
- 7 Bulk delete
- 8 Get deals from default track grouped by milestones
- 9 Get deals for a particular track (grouped by milestone)
- 10 Get deals from particular track
- 11 Get deals related to specific contact
- 12 Get deals of current user (my deals)
- 13 Remove contacts of a deal
- Task fields
- Task APIs
- 1 Get the list of pending tasks depending on the number of pending days
- 2 Get the list of tasks based on given filters
- 3 Get the task based on ID
- 4 Create a task
- 5 Create a task based on Contact email
- 6 Update a task (Partial update)
- 7 Delete a task based on ID
- 8 Listing Tasks
- 9 Get tasks related to contact
- 1 Get documents related to specific contact
- 2 Create a document to a contact
- 3 Update a document to a contact
- 1 Get all tickets
- 2 Create a ticket
- 3 Delete a ticket
- 4 Get all filter IDs
- 5 Get all messages within a ticket
- 6 Add note to a Ticket using Ticket ID
- Create contact test
- Update contact test
- Update tag by ID test
- Create deal test
- Get list of contacts example 1
- Get list of contacts example 2
This is an HTTPS-only API. Authentications are performed based on the email address of the user and the respective API Key.
The Email and API key should pass basic HTTP Authentication. For this, use email address as the username and the respective API Key as the password)
- You may access the API Key from Admin Settings -> API & Analytics -> API Key
- Use the first one (API Key for REST client) for all the REST API calls.
All API requests should be made to: https://{domain}.agilecrm.com/dev/
Note: All data is case-sensitive. Emails, names and other values are case sensitive. For example, "Test" and "test" are considered two different words.
| Field Name | Description | Value Type | Read-Only | Mandatory | Accepted values |
|---|---|---|---|---|---|
| id | Unique id is generated when contact is created | Long | Yes | Yes, to update and delete calls. | N/A |
| type | Type distinguishes a contact and a company. | String | No | No. | Defaults to "PERSON" if not mentioned."PERSON" or "COMPANY" |
| tags | Unique identifiers added to contact, for easy management of contacts. This is not applicable for companies. | List | no | no | Tag name should start with an alphabet and can not contain special characters other than underscore and space. |
| lead_score | Score of contact. This is not applicable for companies. | Integer | no | no | Any positive integer |
| contact_company_id | This field should only be added in the Contact object to specify that the contact works for the given company. | Long | No | No | Company ID can be provided here. Only long values are accepted. |
| star_value | Rating of contact (Max value 5). This is not applicable for companies. | Short | no | no | 0 to 5 |
| properties | Contact properties are represented by list of JSON objects, each JSON object should follow the prototype shown. Custom fields will have type as CUSTOM and others will have type as SYSTEM. | List of JSON objects | no | first_name is mandatory | |
| campaignStatus | Information about campaigns running on a contact, like name, status, start time, end time of campaign | List of JSONObjects | Yes | Only if this contact has campaigns | N/A |
| unsubscribeStatus | Information about the campaign from which the contact is unsubscribed. | List of JSONObjects | Yes | Only if this contact has campaigns | N/A |
| emailBounceStatus | Information about the email bounce and spam while running the campaign | List of JOSNObjects | Yes | Only if this conatct has campaigns | N/A |
| Field Name | Description | Value Type | Read-Only | Mandatory | Accepted values |
|---|---|---|---|---|---|
| name | Name of the field. | String | No | Yes | Any string |
| type | Type of the field (Whether it is system defined field or custom field). | String | No | Yes | SYSTEM or CUSTOM |
| subtype | Sub type of the field.Only SYSTEM properties like email will have the sybtypes. | String | No | No | The value of this field depends up on the property name. |
| value | Value of the property. | String | No | No | Any String. |
The below are the subtypes for respective property fields.
| Name | Type | Syb types |
|---|---|---|
| SYSTEM | work,personal | |
| phone | SYSTEM | work,home,mobile,main,home fax,work fax,other |
| address | SYSTEM | home,postal,office |
| website | SYSTEM | URL,SKYPE,TWITTER,LINKEDIN,FACEBOOK,XING,FEED,GOOGLE_PLUS,FLICKR,GITHUB,YOUTUBE |
Note: There will be subtypes for custom fields. User should specify the above mentioned subtype for those respective properties only.
"properties": [
{
"name": "Text field test",
"type": "CUSTOM",
"value": "I am text field test."
},
{
"name": "Text Area Test",
"type": "CUSTOM",
"value": "I am text area field test. I am CEO of Uptake Technologies. I like Agile Chrome Extension. You can add leads from LinkedIn, Twitter, Facebook, Gmail etc."
},
{
"name": "Date of Joining",
"type": "CUSTOM",
"value": 1279132200
},
{
"name": "Please select checkbox to accept term and condition",
"type": "CUSTOM",
"value": "on"
},
{
"name": "Please select one product from list",
"type": "CUSTOM",
"value": "tomato"
},
{
"name": "Please add what are the companies you worked",
"type": "CUSTOM",
"value": "[\"5694691248963584\",\"5646962099486720\"]"
},
{
"type": "SYSTEM",
"name": "first_name",
"value": "Brad"
},
{
"type": "SYSTEM",
"name": "last_name",
"value": "Keywell"
},
{
"type": "SYSTEM",
"name": "image",
"value": "https://media.licdn.com/mpr/mpr/shrinknp_400_400/AAEAAQAAAAAAAAkpAAAAJDY4ZDg2OTU3LTVhOTAtNGRlOC1hNjAxLTgwNGUyMzc0MDc2Mg.jpg"
},
{
"type": "SYSTEM",
"name": "company",
"value": "Uptake Technologies"
},
{
"type": "SYSTEM",
"name": "title",
"value": "Co-Founder and CEO"
},
{
"name": "email",
"value": "[email protected]",
"subtype": "work"
},
{
"name": "phone",
"value": "8888888888",
"subtype": "work"
},
{
"name": "website",
"value": "https://www.linkedin.com/in/bradkeywell",
"subtype": "LINKEDIN"
},
{
"name": "website",
"value": "https://www.youtube.com/watch?v=8-zQMprfDgE",
"subtype": "YOUTUBE"
},
{
"name": "address",
"value": "{\"address\":\"Motor City 120 street\",\"city\":\"Detroit\",\"state\":\"Michigan\",\"zip\":\"48201\",\"country\":\"US\",\"countryname\":\"United States\"}"
}
]{
"id": "5629585249009664",
"type": "PERSON",
"created_time": "1469170109",
"updated_time": 1469764466,
"last_contacted": 0,
"last_emailed": 0,
"last_campaign_emaild": 0,
"last_called": 0,
"viewed_time": 0,
"viewed": {
"viewed_time": 1469764498855,
"viewer_id": 6263975862861824
},
"star_value": 4,
"lead_score": 5,
"tags": [],
"tagsWithTime": [
{
"tag": "dummyTestTag",
"createdTime": 1469510469602,
"availableCount": 0,
"entity_type": "tag"
}
],
"properties": [
{
"name": "Text field test",
"type": "CUSTOM",
"value": "I am text field test."
},
{
"name": "Text Area Test",
"type": "CUSTOM",
"value": "I am text area field test. I am CEO of Uptake Technologies. I like Agile Chrome Extension. You can add leads from LinkedIn, Twitter, Facebook, Gmail etc."
},
{
"name": "Date of Joining",
"type": "CUSTOM",
"value": 1279132200
},
{
"name": "Please select checkbox to accept term and condition",
"type": "CUSTOM",
"value": "on"
},
{
"name": "Please select one product from list",
"type": "CUSTOM",
"value": "tomato"
},
{
"name": "Please add what are the companies you worked",
"type": "CUSTOM",
"value": "[\"5694691248963584\",\"5646962099486720\"]"
},
{
"type": "SYSTEM",
"name": "first_name",
"value": "Brad"
},
{
"type": "SYSTEM",
"name": "last_name",
"value": "Keywell"
},
{
"type": "SYSTEM",
"name": "image",
"value": "https://media.licdn.com/mpr/mpr/shrinknp_400_400/AAEAAQAAAAAAAAkpAAAAJDY4ZDg2OTU3LTVhOTAtNGRlOC1hNjAxLTgwNGUyMzc0MDc2Mg.jpg"
},
{
"type": "SYSTEM",
"name": "company",
"value": "Uptake Technologies"
},
{
"type": "SYSTEM",
"name": "title",
"value": "Co-Founder and CEO"
},
{
"name": "email",
"value": "[email protected]",
"subtype": "work"
},
{
"name": "phone",
"value": "8888888888",
"subtype": "work"
},
{
"name": "website",
"value": "https://www.linkedin.com/in/bradkeywell",
"subtype": "LINKEDIN"
},
{
"name": "website",
"value": "https://www.youtube.com/watch?v=8-zQMprfDgE",
"subtype": "YOUTUBE"
},
{
"name": "address",
"value": "{\"address\":\"Motor City 120 street\",\"city\":\"Detroit\",\"state\":\"Michigan\",\"zip\":\"48201\",\"country\":\"US\",\"countryname\":\"United States\"}"
}
],
"campaignStatus": [],
"entity_type": "contact_entity",
"contact_company_id": "5649189358796800",
"unsubscribeStatus": [],
"emailBounceStatus": [],
"formId": 0,
"owner": {
"id": 6263975862861824,
"domain": "ghanshyam",
"email": "[email protected]",
"name": "Ghanshyam",
"pic": "https://d1gwclp1pmzk26.cloudfront.net/img/gravatar/25.png",
"schedule_id": "Ghanshyam",
"calendar_url": "https://ghanshyam.agilecrm.com/calendar/Ghanshyam",
"calendarURL": "https://ghanshyam.agilecrm.com/calendar/Ghanshyam"
}
}Method: GET
- returns list of contacts in domain which are ordered by creation time.
For the Response in the Json format, add the header 'Accept' as application/json. By default, the response will be in XML format. Paging can be applied using the page_size and cursor query parameters. Count of the contacts will be in the first contact and Cursor for the next page will be in the last contact of the list. If there is no cursor, it means that it is the end of list.
curl https://{domain}.agilecrm.com/dev/api/contacts?page_size=20&cursor=E-ABAIICNGoRc35hZ2lsZS1jcm0tY2xvdWRyFAsSB0NvbnRhY3QYgICAgKLThAoMogEIcHJhYmF0aGuIAgAU \
-H "Accept : application/json" \
-v -u [email protected]:123456 [
{
"id": 5073269292007424,
"type": "PERSON",
"created_time": 1445941332,
"updated_time": 1451545213,
"star_value": 0,
"lead_score": 0,
"tags": [
"Sample based",
"tag1",
"tag3",
"tag2"
],
"tagsWithTime": [
{
"tag": "Sample based",
"createdTime": 1449716452263,
"availableCount": 0,
"entity_type": "tag"
},
{
"tag": "tag1",
"createdTime": 1449716779882,
"availableCount": 0,
"entity_type": "tag"
},
{
"tag": "tag3",
"createdTime": 1449716997174,
"availableCount": 0,
"entity_type": "tag"
},
{
"tag": "tag2",
"createdTime": 1449716997174,
"availableCount": 0,
"entity_type": "tag"
}
],
"properties": [
{
"type": "CUSTOM",
"name": "text sample test",
"value": "text custom"
},
{
"type": "CUSTOM",
"name": "TeamNumbers",
"value": "5"
},
{
"type": "SYSTEM",
"name": "first_name",
"value": "April"
},
{
"type": "SYSTEM",
"name": "last_name",
"value": "Woodlif"
},
{
"type": "SYSTEM",
"name": "email",
"subtype": "",
"value": "[email protected]"
},
{
"type": "SYSTEM",
"name": "phone",
"value": "6767678982"
},
{
"type": "SYSTEM",
"name": "phone",
"subtype": "home",
"value": "6767678982"
}
]
},
{
"cursor": "CjsSNWoRc35hZ2lsZS1jcm0tY2xvdWRyFAsSB0NvbnRhY3QYgICA8MTNhAkMogEJZ2hhbnNoeWFtGAAgAA",
"id": 5086805955182592,
"type": "PERSON",
"created_time": 1448516471,
"star_value": 4,
"lead_score": 92,
"tags": [
"Lead",
"Likely Buyer"
],
"tagsWithTime": [
{
"tag": "Lead",
"createdTime": 1448516471573,
"availableCount": 0,
"entity_type": "tag"
},
{
"tag": "Likely Buyer",
"createdTime": 1448516471573,
"availableCount": 0,
"entity_type": "tag"
}
],
"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": "[email protected]"
},
{
"type": "SYSTEM",
"name": "address",
"value": "{\"address\":\"MIG-106\",\"city\":\"Hyderabad\",\"state\":\"Telangana\",\"zip\":\"500032\",\"country\":\"India\"}"
},
{
"type": "CUSTOM",
"name": "My Custom Field",
"value": "Custom value"
}
]
}
]- Status 200: Gives the above JSON object in above format.
- Status 204: There are no contacts in your account.
- Status 401: Unauthorised (when the user name and password fields are wrong.)
Method: GET
- Returns contact object which is associated with given id
curl https://{domain}.agilecrm.com/dev/api/contacts/{id} \
-H "Accept :application/json" \
-v -u [email protected]:123456- Returns created contact object with all parameters in it as mentioned in the above example.
- Status 200: Gives the above JSON object in above format.
- Status 204: No contact with the specified ID in your account.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
Method: POST
Accepts contact JSON as post data along with the credentials of domain User (User name and API Key).
- Each field is case sensitive.
- Please don't pass null value.
- If you don't know value of field then either don't pass that field or pass empty data to a field.
{
"star_value": "4",
"lead_score": "92",
"tags": [
"Lead",
"Likely Buyer"
],
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "Samson"
},
{
"type": "SYSTEM",
"name": "last_name",
"value": "Nolan"
},
{
"type": "SYSTEM",
"name": "email",
"subtype": "work",
"value": "[email protected]"
},
{
"type": "SYSTEM",
"name": "address",
"value": "{\"address\":\"225 George Street\",\"city\":\"NSW\",\"state\":\"Sydney\",\"zip\":\"2000\",\"country\":\"Australia\"}"
},
{
"name": "phone",
"value": "8888888889",
"subtype": "work"
},
{
"name": "phone",
"value": "8888888889",
"subtype": "home"
},
{
"name": "website",
"value": "www.youtube.com",
"subtype": "YOUTUBE"
},
{
"name": "website",
"value": "www.linkedin.com",
"subtype": "LINKEDIN"
},
{
"name": "website",
"value": "www.mywebsite.com",
"subtype": "URL"
},
{
"name": "My custom field of type text",
"type": "CUSTOM",
"value": "My name is ghanshyam"
},
{
"name": "My custom field of type date",
"type": "CUSTOM",
"value": 1479580200
},
{
"name": "My custom field of type checkbox",
"type": "CUSTOM",
"value": "on"
},
{
"name": "My custom field of type list",
"type": "CUSTOM",
"value": "lemon"
},
{
"name": "My custom field of type companies",
"type": "CUSTOM",
"value": "[\"5767466600890368\",\"5114076984246272\",\"5746725247516672\"]"
}
]
}curl https://{domain}.agilecrm.com/dev/api/contacts \
-H "Accept : application/json" \
-H "Content-Type: application/json" \
-d '{
"star_value": "4",
"lead_score": "92",
"tags": [
"Lead",
"Likely Buyer"
],
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "Samson"
},
{
"type": "SYSTEM",
"name": "last_name",
"value": "Nolan"
},
{
"type": "SYSTEM",
"name": "email",
"subtype": "work",
"value": "[email protected]"
},
{
"type": "SYSTEM",
"name": "address",
"value": "{\"address\":\"225 George Street\",\"city\":\"NSW\",\"state\":\"Sydney\",\"zip\":\"2000\",\"country\":\"Australia\"}"
}
]
}' \
-v -u [email protected]:123456 -X POST- Status 200: Contact added successfully. Returns the newly added contact object in the response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format.
- Status 406: If the limit of the contacts is exceeded.
Method: PUT
We can update required property fields of the contact using this call. It is used to add the new property or update the existing property. It accepts property object of contact with valid parameter in it. We need to send the Contact-Id of the contact to identify it. This will not affect other fields.
Using this API you can not delete properties.If subtype is same for phone,website or email then value can be overridden. Lead score, star value and tags can not be updated using this API. follow the below API for editing lead score,star value and tags.
{
"id": "5676477903273984",
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "Samson"
},
{
"type": "SYSTEM",
"name": "last_name",
"value": "Nolan"
},
{
"type": "SYSTEM",
"name": "email",
"subtype": "work",
"value": "[email protected]"
},
{
"type": "SYSTEM",
"name": "address",
"value": "{\"address\":\"225 George Street\",\"city\":\"NSW\",\"state\":\"Sydney\",\"zip\":\"2000\",\"country\":\"Australia\"}"
}
]
}curl https://{domain}.agilecrm.com/dev/api/contacts/edit-properties \
-H "Accept : application/json" \
-H "Content-Type: application/json" \
-d '{
"id": "5725836472745984",
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "Santar"
}
]
}' \
-v -u [email protected]:123456 -X PUT- Status 200: Contact updated successfully. Returns the updated contact object in the response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format.
Method: PUT
We can update lead score of a contact using this call. It accepts lead score and contact id of contact with valid parameter. We need to send the Contact-Id of the contact to identify it. This will not affect other fields.
{
"id": "5676477903273984",
"lead_score": 20
}curl https://{domain}.agilecrm.com/dev/api/contacts/edit/lead-score \
-H "Accept : application/json" \
-H "Content-Type: application/json" \
-d '{
"id": "5725836472745984",
"lead_score": 150
}' \
-v -u [email protected]:123456 -X PUT- Status 200: Lead score updated successfully. Returns the updated contact object in the response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format.
###dev/api/contacts/edit/add-star Method: PUT
We can update star value of a contact using this call. It accepts star value and contact id of contact with valid parameter. We need to send the Contact-Id of the contact to identify it. This will not affect other fields.
{
"id": "5676477903273984",
"star_value": 20
}curl https://{domain}.agilecrm.com/dev/api/contacts/edit/add-star \
-H "Accept : application/json" \
-H "Content-Type: application/json" \
-d '{
"id": "5725836472745984",
"star_value": 2
}' \
-v -u [email protected]:123456 -X PUT- Status 200: Star value updated successfully. Returns the updated contact object in the response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format.
Method: PUT
We can add tag values of a contact using this call. It accepts tag values and contact id of contact with valid json format. We need to send the Contact-Id of the contact to identify it. This will not affect other fields.
{
"id": "4584963487825920",
"tags": [
"test1",
"test2"
]
}curl https://{domain}.agilecrm.com/dev/api/contacts/edit/tags \
-H "Accept : application/json" \
-H "Content-Type: application/json" \
-d '{
"id": "5725836472745984",
"tags": [
"test1",
"test2"
]
}' \
-v -u [email protected]:123456 -X PUT- Status 200: tags value added/updated successfully. Returns the updated contact object in the response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format.
Method: PUT
We can delete tag values of a contact or company using this call. It accepts tag values and contact id of contact with valid json format. We need to send the Contact-Id of the contact to identify it.This call searches for the contact based on the given contact id and searches for the given tag in the contact's tag list. If there is a match, then it deletes that tag. You can delete multiple tags.
{
"id": "4584963487825920",
"tags": [
"test1",
"test2"
]
}curl https://{domain}.agilecrm.com/dev/api/contacts/delete/tags \
-H "Accept : application/json" \
-H "Content-Type: application/json" \
-d '{
"id": "5725836472745984",
"tags": [
"test1",
"test2"
]
}' \
-v -u [email protected]:123456 -X PUT- Status 200: tags value deleted successfully. Returns the tag list in the response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format.
Method: DELETE
- Deletes contact based on the id of the contact, which is sent in request url path.
curl https://{domain}.agilecrm.com/dev/api/contacts/{id} \
-v -u {email}:{apikey} -X DELETE- Status 204: Contact deleted successfully.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
Method: GET
- Returns contact object which is associated with given email
curl https://{domain}.agilecrm.com/dev/api/contacts/search/email/{email} \
-H "Accept :application/json" \
-v -u {email}:{apikey} -X GET- Returns created contact object with all parameters in it as mentioned in the above example.
- Status 200: Gives the above JSON object in above format.
- Status 204: No contact with the specified phone number in your account.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
Method: POST
- Searches for the contact with given email address. Email address should be sent as a form parameter (Content-Type: application/x-www-form-urlencoded ). We can search for multiple contacts using their Email-Ids.
curl https://{domain}.agilecrm.com/dev/api/contacts/search/email -H "Accept: application/json" \
-H "Content-Type :application/x-www-form-urlencoded" \
-d 'email_ids=["[email protected]"]' \
-v -u [email protected]:123456 -X POST- Status 200: Gives the Contact as JSON object in the above format. If email doesn’t match, it will return an empty object.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the email is in wrong format.
Method: GET
Parameters allowed are as below. All parameters are mandatory.
-
‘q' - Search keyword (all contact/company default fields and searchable custom fields will be searched)
-
‘page_size’ - Number of results to fetch
-
'type' - Should be 'PERSON' for searching Contacts and 'COMPANY' for Companies
curl https://{domain}.agilecrm.com/dev/api/search?q=ab&page_size=10&type="COMPANY" -H "Accept: application/json" -v -u {email}:{apikey}- Status 200: Gives the list of Companies/Contacts.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
Method: POST
- Searches for the contact based on the given email address and adds the given tags to the contact. You can add multiple tags. Tags should be sent as an array. Email address (email) and tags (tags) array should be sent as a form parameter (Content-Type: application/x-www-form-urlencoded ).Tag name should start with an alphabet and can not contain special characters other than underscore and space.
curl https://{domain}.agilecrm.com/dev/api/contacts/email/tags/add -H "Accept: application/json" \
-H "Content-Type :application/x-www-form-urlencoded" \
-d '[email protected]&tags=["testingtesto"]' \
-v -u [email protected]:123456 -X POST- Status 204: Tags added successfully.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format.
Method: POST
- Searches for the contact based on the given email address and searches for the given tag in the contact's tag list. If there is a match, then it deletes that tag. You can delete multiple tags. Tags should be sent as an array. Email address (email) and tags (tags) array should be sent as a form parameter(Content-Type: application/x-www-form-urlencoded )
curl https://{domain}.agilecrm.com/dev/api/contacts/email/tags/delete -H "Accept: application/json"
-H "Content-Type :application/x-www-form-urlencoded" \
-d '[email protected]&tags=["testingtesto"]' \
-v -u [email protected]:123456 -X POST- Status 204: Tags deleted successfully.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format.
Method: POST
- It is used to change the score of the contact using the email address. If you want to decrease the existing score, then use negative values for the score parameter.
curl https://{domain}.agilecrm.com/dev/api/contacts/add-score -H "Accept: application/json" \
-H "Content-Type :application/x-www-form-urlencoded" \
-d '[email protected]&score=100' \
-v -u [email protected]:123456 -X POST- Status 200: Score changed successfully and it returns the Contact object.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
Method: GET
- Retrieves the tasks related to contact, sorted by the date (latest first.).
curl https://{domain}.agilecrm.com/dev/api/contacts/{contact_id}/tasks/sort -H "Accept: application/json" -v -u {email}:{apikey}- Status 200: Returns the tasks list related to the contact.
[
{
"id": 5152971570544640,
"type": "EMAIL",
"priority_type": "NORMAL",
"due": 1409596200,
"created_time": 1409567774,
"is_complete": false,
"contacts": [
{
"id": 5716606839685120,
"type": "PERSON",
"created_time": 1403057154,
"updated_time": 1403057154,
"viewed_time": 0,
"viewed": {
"viewed_time": 1409567737463,
"viewer_id": 5345980119515136
},
"star_value": 0,
"lead_score": 0,
"tags": [],
"tagsWithTime": [],
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "Basecamp (2Desk)"
},
{
"type": "SYSTEM",
"name": "last_name",
"value": "Basecamp (2Desk)"
},
{
"type": "SYSTEM",
"name": "email",
"value": "[email protected]"
}
],
"campaign- Status": [],
"entity_type": "contact_entity",
"unsubscribe- Status": [],
"emailBounce- Status": [],
"owner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "[email protected]",
"is_admin": true,
"is_account_owner": true,
"is_disabled": false,
"name": "prabath kolipaka"
}
}
],
"subject": "Contact created in agile crm",
"entity_type": "task",
"notes": [],
"progress": 0,
"- Status": "YET_TO_START",
"ownerPic": "https://s3.amazonaws.com/agilecrm/panel/uploaded-logo/1401427105618?id=upload-container",
"taskOwner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "[email protected]",
"is_admin": true,
"is_account_owner": true,
"is_disabled": false,
"name": "prabath kolipaka"
}
}
]- Status 401: Unauthorised. (when the user name and password fields are wrong.)
Method: POST
We can update a single field of the contact using this call. It is used to add the new property or update the existing property. It accepts property object of contact with valid parameter in it. We need to send the Email-Id of the contact to identify it. This will not effect other fields.
curl https://{domain}.agilecrm.com/dev/api/contacts/add/property?[email protected] \
-H "Content-Type: application/json" \
-d '{
"type": "SYSTEM",
"name": "first_name",
"value": "hans"
}' \
-v -u [email protected]:123456 -X POST {
"type": "SYSTEM",
"name": "first_name",
"value": "Los "
}If there is no ID, it will considered as a new contact.
- Status 200: Contact updated successfully. Returns the updated contact object in the response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format.
Method: POST
We can update the owner of the contact using this call. It will take two parameters. One is the email address of the user (owner_email) and the second one is the ID of the contact(contact_id). Both fields are mandatory.
curl https://{domain}.agilecrm.com/dev/api/contacts/change-owner \
-H "Content-Type: application/x-www-form-urlencoded" \
-d '[email protected]&contact_id=5646748928180224' \
-v -u [email protected]:4uet78u6atfn38m9dounnq9g4u -X POST - Status 200: Owner changed successfully. Returns the updated contact object in the response. If the user does not exists with the given email, it returns a message saying user does not exist with that email.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format.
Method: POST
- This is used when a contact added to campaign (with an email address)
curl https://{domain}.agilecrm.com/dev/api/campaigns/enroll/email \
-H "Accept: application/json" \
-H "Content-Type :application/x-www-form-urlencoded" \
-d '[email protected]&workflow-id = 5727517264576512' \
-v -u {email}:{apikey} -X POST- Status 200: Campaign added successfully to the Contact.
- Status 401: Unauthorized (When the User Name and Password fields are wrong.)
- Status 400: If the input is in the wrong format
Method: DELETE
- This is used when a contact needs to be taken off a campaign with the contact's contact_id. In other words, to unsubscribe a contact from a campaign.
curl https://{domain}.agilecrm.com/dev/api/workflows/remove-active-subscriber/{workflow-id}/{contact_id} \
-H "Accept : application/json" \
-v -u {email} : {API Key} -X DELETE- Status 204: Campaign removed successfully from the Contact.
- Status 401: Unauthorized (When the User Name and Password fields are wrong.)
- Status 400: If the input is in the wrong format
Method: GET
- Returns contact object which is associated with given phone number
curl https://{domain}.agilecrm.com/dev/api/contacts/search/phonenumber/{phone-number} \
-H "Accept :application/json" \
-v -u {email}:{apikey}- Status 200: Returns contact json data.
- Status 204: No contact with the specified phone number in your account.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
Method: POST
- Returns contacts or companies object which is associated with given filter
curl https://{your_domain}.agilecrm.com/dev/api/filters/filter/dynamic-filter -H "Accept: application/json" \
-H "Content-Type :application/x-www-form-urlencoded" \
-d 'page_size=25&global_sort_key=-created_time&filterJson={"rules":[{"LHS":"tags","CONDITION":"EQUALS","RHS":"linkedin prospect"}],"contact_type":"PERSON"}' \
-v -u [email protected]:123fghfhf******* -X POST- Status 200: Returns contact json data.
- Status 204: No contact with the specified phone number in your account.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
Method: POST
- Returns contacts or companies object which is associated with given filter
curl https://{your_domain}.agilecrm.com/dev/api/filters/filter/dynamic-filter -H "Accept: application/json" \
-H "Content-Type :application/x-www-form-urlencoded" \
-d 'page_size=25&global_sort_key=-created_time&filterJson={"rules":[{"LHS":"EmployeeDataCustom","CONDITION":"EQUALS","RHS":"prospect001"}],"contact_type":"PERSON"}' \
-v -u [email protected]:123fghfhf******* -X POST- Status 200: Returns contact json data.
- Status 204: No contact with the specified phone number in your account.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
Method: POST
-
Accepts company JSON as post data along with the credentials of domain User (User name and API Key).
-
Each field is case sensitive.
-
Please don't pass null value.
-
If you don't know value of field then either don't pass that field or pass empty data to a field.
{
"type": "COMPANY",
"star_value": 4,
"lead_score": 120,
"tags": [
"Permanent",
"USA",
"Hongkong",
"Japan"
],
"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"
}
]
}curl https://{domain}.agilecrm.com/dev/api/contacts \
-H "Accept : application/json" \
-H "Content-Type: application/json" \
-d '{
"type": "COMPANY",
"star_value": 4,
"lead_score": 120,
"tags": [
"Permanent",
"USA",
"Hongkong",
"Japan"
],
"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": "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"
}
]
}' \
-v -u [email protected]:123456 -X POST- Returns created company object with all parameters in it as mentioned in the above example.
- Status Status 200: Company added successfully. Returns the newly added company object in the response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format.
- Status 406: If the limit of the contacts is exceeded.
Method: PUT
- We can update required property fields of the company using this call. It is used to add the new property or update the existing property. It accepts property object of company with valid parameter in it. We need to send the Company-Id of the company to identify it. This will not affect other fields.
{
"id":5651082298523648,
"properties": [
{
"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"
}
]
}curl https://{domain}.agilecrm.com/dev/api/contacts/edit-properties \
-H "Accept : application/json" \
-H "Content-Type: application/json" \
-d '{
"id": 5694691248963584,
"properties": [
{
"type": "SYSTEM",
"name": "name",
"value": "SPICE JET"
},
{
"type": "SYSTEM",
"name": "url",
"value": "http://www.spicejet.com/"
},
{
"name": "phone",
"value": "45500000",
"subtype": ""
}
]
}' \
-v -u [email protected]:123456 -X PUT- Returns updated company object with all parameters in it as mentioned in the above example.
- Status Status 200: Company updated successfully. Returns the updated contact object in the response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format.
Method: POST
- Fetches list of companies. Page_size,global_sort_key and cursor should be sent as a form parameter (Content-Type: application/x-www-form-urlencoded ).Paging can be applied using the page_size and cursor form parameters. Cursor for the next page will be in the last company of the list. If there is no cursor, it means that it is the end of list.
curl https://{domain}.agilecrm.com/dev/api/contacts/companies/list \
-H "Accept: application/json" \
-H "Content-Type :application/x-www-form-urlencoded" \
-d 'page_size=25&global_sort_key=-created_time&cursor=ClMKFgoMY3JlYXRlZF90aW1lEgYI-rbWrgUSNWoRc35hZ2lsZS1jcm0tY2xvdWRyFAsSB0NvbnRhY3QYgICAkNv0nQoMogEJZ2hhbnNoeWFtGAAgAQ' \
-v -u [email protected]:123456 -X POST[
{
"id": 5638758711951360,
"type": "COMPANY",
"created_time": 1439390694,
"updated_time": 0,
"last_contacted": 0,
"last_emailed": 0,
"last_campaign_emaild": 0,
"last_called": 0,
"viewed_time": 0,
"viewed": {
"viewed_time": 0
},
"star_value": 0,
"lead_score": 0,
"tags": [],
"tagsWithTime": [],
"properties": [
{
"type": "SYSTEM",
"name": "name",
"value": "infosys"
},
{
"type": "SYSTEM",
"name": "name_lower",
"value": "infosys"
}
]
},
{
"id": 5689143912824832,
"type": "COMPANY",
"created_time": 1438784350,
"updated_time": 0,
"last_contacted": 0,
"last_emailed": 0,
"last_campaign_emaild": 0,
"last_called": 0,
"viewed_time": 0,
"viewed": {
"viewed_time": 0
},
"star_value": 0,
"lead_score": 0,
"tags": [],
"tagsWithTime": [],
"properties": [
{
"type": "SYSTEM",
"name": "name",
"value": "lead"
},
{
"type": "SYSTEM",
"name": "name_lower",
"value": "lead"
}
]
}
]- Status 200: Successfully retrieved the companies list.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
Method: GET
- Returns company object which is associated with given company id
curl https://{domain}.agilecrm.com/dev/api/contacts/{id} -H "Accept :application/json"
-v -u {email}:{apikey}{
"id": 5638758711951360,
"type": "COMPANY",
"created_time": 1439390694,
"updated_time": 0,
"last_contacted": 0,
"last_emailed": 0,
"last_campaign_emaild": 0,
"last_called": 0,
"viewed_time": 0,
"viewed": {
"viewed_time": 0
},
"star_value": 0,
"lead_score": 0,
"tags": [],
"tagsWithTime": [],
"properties": [
{
"type": "SYSTEM",
"name": "name",
"value": "infosys"
},
{
"type": "SYSTEM",
"name": "name_lower",
"value": "infosys"
}
]
}- Status 200: Gives the above JSON object in above format.
- Status 204: No contact with the specified ID in your account.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
Method: DELETE
- Deletes company based on the id of the company, which is sent in request url path.
curl https://{domain}.agilecrm.com/dev/api/contacts/{id} \
-v -u {email}:{apikey} -X DELETE- Status 204: Company deleted successfully.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Deals API
| Field Name | Description | Value Type | Read Only | Mandatory | Accepted Values |
|---|---|---|---|---|---|
| id | Unique id is assigned to every deal, when it is created | Long | no | Yes, if request is to update an existing deal | N/A |
| name | Name of the deal | string | no | Yes | N/A |
| description | Brief description about deal. | string | no | No | N/A |
| expected_value | Estimated value of a deal. | double | no | Yes | Max up to 1000000000000 |
| pipeline_id | Track id of the deal. | long | no | Yes | There should be a track with this Id. |
| milestone | Milestone of deal (won, progress, lost..). These depend up on the track selected. Milestones may differ based on the tracks. | String | no | Yes | MIlestone in the above mentioned track. |
| probability | integer | no | should be ranging between 0-100 | 0 to 100 | |
| close_date | close date of deal | long | no | Yes | Epoch time |
| created_time | Created time of the deal. Returns time in seconds | long | yes | No, generated automatically on deal creation | Epoch time |
| owner_id | owner_id represents id of domain user | string | No, write access is provided to set owner of deal | Yes | The id of the user. |
| prefs | JSON string | N/A | |||
| contacts | Relates list of contacts to deal | List of contact. | Yes | No | |
| contact_ids | Relates list of contacts to deal. They Should be sent in the request while creating and updating contacts. | List of contact id.ex: ["122", 145,201]. | Write access to relate contacts, while returning contact jsons respective to ids set | No | IDs of contacts. |
{
"name": "Carz008",
"owner_id": "6263975862861824",
"expected_value": "85000",
"probability": "89",
"pipeline_milestone": "5730082031140864_Prospect",
"close_date": 1472581800,
"pipeline_id": "5730082031140864",
"milestone": "Prospect",
"deal_source_id": "5762909909024768",
"color1": "#0000ff",
"lost_reason_id": "",
"relates_to": "",
"description": "This is deal description",
"archived": false,
"contact_ids": [
"5698320831873024"
],
"custom_data": [
{
"name": "Deal greetings",
"value": "Welcome to Deal greeting custom field"
},
{
"name": "Deal From",
"value": "This Deal from Zapan"
}
],
"colorName": "BLUE",
"tagsWithTime": [
{
"tag": "intersted"
},
{
"tag": "developer"
}
]
}Method: GET
- Returns list of all "Deals" in the domain in JSON format, which are ordered by created time. Paging can be applied using the page_size and cursor query parameters. Count of the deals will be in the first deal and the cursor for the next page will be in the last deal of the list. If there is no cursor, it means that it is the end of the list.
curl https:{domain}.agilecrm.com/dev/api/opportunity?page_size=10&cursor=E-ABAIICNGoRc35hZ2lsZS1jcm0tY2xvdWRyFAsSB0NvbnRhY3QYgICAgKLThAoMogEIcHJhYmF0aGuIAgAU -H "Accept:application/json" -v -u {email}:{API Key} [
{
"id": 981,
"name": "premium subscriptions",
"contacts": [
{
"id": 2363,
"type": "PERSON",
"created_time": 1359033520,
"updated_time": 1359033533,
"star_value": 0,
"lead_score": 0,
"tags": [],
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "John"
},
{
"type": "SYSTEM",
"name": "last_name",
"value": "Olsen"
},
{
"type": "SYSTEM",
"name": "email",
"value": "[email protected]"
}
],
"domainUser": {
"id": 516,
"email": "[email protected]",
"is_admin": true,
"is_account_owner": false,
"is_disabled": false,
"name": "ram"
}
}
],
"description": "Deal premium plan subscription",
"expected_value": 300,
"pipeline_id" : "43535822",
"milestone": "Open",
"probability": 46,
"close_date": 1371753000,
"created_time": 1360503631,
"entity_type": "deal",
"owner": {
"id": 516,
"email": "[email protected]",
"is_admin": true,
"is_account_owner": false,
"is_disabled": false,
"name": "Test"
},
"prefs": {
"id": 984,
"pic": "",
"template": "blue",
"width": "",
"currency": "USD",
"signature": "- Powered by AgileCRM",
"task_reminder": true,
"currentDomainUserName": "?"
},
"pic": ""
},
{
"id": 981,
"name": "premium subscriptions",
"contacts": []
}
]- Status 401: Unauthorised. (when the user name and password fields are wrong.)
Method: GET - Gets the deal with the given ID.
curl https:{domain}.agilecrm.com/dev/api/opportunity/981 -H "Accept : application/json" -v -u {email}:{API Key}{
"id": 981,
"name": "500 premium subscriptions",
"contacts": [
{
"id": 2363,
"type": "PERSON",
"created_time": 1359033520,
"updated_time": 1359033533,
"star_value": 0,
"lead_score": 0,
"tags": [
],
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "John"
},
{
"type": "SYSTEM",
"name": "last_name",
"value": "Olsen"
},
{
"type": "SYSTEM",
"name": "email",
"value": "[email protected]"
},
],
"domainUser": {
"id": 516,
"email": "[email protected]",
"is_admin": true,
"is_account_owner": false,
"is_disabled": false,
"name": "ram",
"password": "PASSWORD",
"info_json_string": "{\"logged_in_time\":1360503513,\"created_time\":1353507148}"
}
}
],
"description": "Deal premium plan subscription",
"expected_value": 300,
"pipeline_id" :"43535822",
"milestone": "Open",
"probability": 46,
"close_date": 1371753000,
"created_time": 1360503631,
"entity_type": "deal",
"owner": {
"id": 516,
"email": "[email protected]",
"is_admin": true,
"is_account_owner": false,
"is_disabled": false,
"name": "ram",
"password": "PASSWORD",
"info_json_string": "{\"logged_in_time\":1360503513,\"created_time\":1353507148}"
},
"prefs": {
"id": 984,
"pic": "",
"template": "blue",
"width": "",
"currency": "USD",
"signature": "- Powered by AgileCRM",
"task_reminder": true,
"currentDomainUserName": "?"
},
"pic": ""
}- Status 401: Unauthorised. (when the user name and password fields are wrong.)
Method: POST
-
Accepts deal JSON as data in Post request to the url specified above, which creates new deal and returns the deal JSON with id field generated when new deal is created. If Post data includes valid deal id, respective deal is updated with the data sent in request. Milestone name should be same as the the one in the website and it is case sensitive. (If the milestone name is given in the wrong case, it will not be shown in the milestone view.)
-
Each field is case sensitive.
-
Please don't pass null value.
-
If you don't know value of field then either don't pass that field or pass empty data to a field.
-
Note : expected_value is mandatory field.
{
"name": "Deal-Tomato",
"expected_value": "500",
"probability": "75",
"close_date": 1455042600,
"milestone": "Proposal",
"contact_ids": [
"5758948741218304"
],
"custom_data": [
{
"name": "Group Size",
"value": "10"
}
]
}curl https://{domain}.agilecrm.com/dev/api/opportunity \
-H "Accept : application/json" \
-H "Content-Type: application/json" \
-d '{
"name": "Deal-Tomato",
"expected_value": "500",
"probability": "75",
"close_date": 1455042600,
"milestone": "Proposal",
"contact_ids": [
"5694691248963584"
],
"custom_data": [
{
"name": "Group Size",
"value": "10"
}
]
}' \
-v -u [email protected]:123456 -X POST- Status 200: Deal added successfully and it returns the newly created deal as JSON in response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
Method: PUT
We can update deal using this call. It accepts Deal JSON. Id parameter of the deal should be specified. It indicates the deal to be updated with the new data sent. Milestone name should be same as the the one in the website and it is case sensitive. (If the milestone name is given in wrong case, it will not be shown in the milestone view.). This will not affect other fields.
{
"id": "5631693742407680",
"expected_value": "1000",
"probability": "20",
"contact_ids": [
"5629703511605248",
"5744178885558278"
],
"custom_data": [
{
"name": "dealTester",
"value": "hello hello2"
}
]
}curl https://{domain}.agilecrm.com/dev/api/opportunity/partial-update \
-H "Accept : application/json" \
-H "Content-Type: application/json" \
-d '{
"id":5717827835133952,
"name": "Deal-Tomato",
"expected_value": "600",
"probability": "100",
"milestone": "Proposal",
"contact_ids": [
"5694691248963584"
]
}' \
-v -u [email protected]:123456 -X PUT- Status 200: Deal updated successfully. Returns the updated deal object in the response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format.
Method: POST
- Accepts deal JSON as data in Post request to the url specified above, which creates new deal and returns the deal JSON with id field generated when new deal is created. If Post data includes valid deal id, respective deal is updated with the data sent in request. Milestone name should be same as the the one in the website and it is case sensitive. (If the milestone name is given in the wrong case, it will not be shown in the milestone view.)
curl https://{domain}.agilecrm.com/dev/api/opportunity/email/[email protected] \
-H "Accept : application/json" \
-H "Content-Type: application/json" \
-d '{
"name": "Deal-Tomato",
"expected_value": "500",
"probability": "75",
"close_date": 1455042600,
"milestone": "Proposal",
"custom_data": [
{
"name": "Group Size",
"value": "10"
}
]
}' \
-v -u [email protected]:123456 -X POSTCreates a deal for the contact with the given email address. If there is no contact, it will not create any deal.
- Status 200: Deal added successfully and it returns the new created deal as JSON in response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
Method: DELETE
- Deletes the deal based on the id specified in the url.
curl https://{domain}.agilecrm.com/dev/api/opportunity/{id} -H "Content-Type: application/json" -v -u [email protected]:4uet78u6atfn38m9dounnq9g4u -X DELETE- Status 204: Deal deleted successfully.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
Method: POST
- Accepts list of deal ids in Post request and deletes all deals based on list of ids sent.
curl https://{domain}.agilecrm.com/dev/api/opportunity/bulk \
-H "Content-Type: application/x-www-form-urlencoded" \
-d '{
"ids": [
"123",
"234",
"235"
]
}' \
-v -u {email}:{API Key} -X POST- Status 200: Deal deleted successfully.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
Method: GET
- Fetches list of deals from the default track grouped by milestones. Number of milestones depends upon the milestones added by user to default track.
curl https://{domain}.agilecrm.com/dev/api/opportunity/byMilestone -H "Accept : application/json" -v -u {email} : {API Key}{
"Lost": [
{
"cursor": "",
"count": "",
"id": 5086100271923200,
"name": " Nike Endorsement",
"contact_ids": [
],
"custom_data": [
{
"name": "Ddate",
"value": "07/11/2014"
}
],
"description": "Advertisements and apparel for Nike",
"expected_value": 2000000.0,
"pipeline_id" :"43535822",
"milestone": "Lost",
"probability": 98,
"close_date": 1468800,
"owner_id": "",
"created_time": 1405085631,
"track": "",
"entity_type": "deal",
"notes": [
],
"note_description": "",
"owner": {
"cursor": "",
"count": "",
"id": 5345980119515136,
"domain": "prabathk",
"email": "[email protected]",
"is_admin": true,
"is_account_owner": true,
"is_disabled": false,
"email_template": "",
"name": "prabath kolipaka"
},
"contacts": [
],
"pic": "https://s3.amazonaws.com/agilecrm/panel/uploaded-logo/1401427105618?id=upload-container"
}
],
Open: [
{
"cursor": "",
"count": "",
"id": 5115435166990336,
"name": " test deal",
"contact_ids": [
],
"custom_data": [
{
"name": "Ddate",
"value": "07/23/2014"
}
],
"description": "testing",
"expected_value": 1235.0,
"pipeline_id" :"43535822",
"milestone": "Lost",
"probability": 123,
"close_date": 1405555200,
"owner_id": "",
"created_time": 1405518785,
"track": "",
"entity_type": "deal",
"notes": [
],
"note_description": "",
"owner": {
"cursor": "",
"count": "",
"id": 5345980119515136,
"domain": "prabathk",
"email": "[email protected]",
"is_admin": true,
"is_account_owner": true,
"is_disabled": false,
"email_template": "",
"name": "prabath kolipaka"
},
"contacts": [
],
"pic": "https://s3.amazonaws.com/agilecrm/panel/uploaded-logo/1401427105618?id=upload-container"
}
],
Won: [
{
"cursor": "",
"count": "",
"id": 5123586478047232,
"name": " deal test",
"contact_ids": [
],
"custom_data": [
{
"name": "Ddate",
"value": "07/21/2014"
}
],
"description": "",
"expected_value": 1.0E10,
"pipeline_id" :"43535822",
"milestone": "Lost",
"probability": 10,
"close_date": 1405036800,
"owner_id": "",
"created_time": 1405575543,
"track": "",
"entity_type": "deal",
"notes": [
],
"note_description": "",
"owner": {
"cursor": "",
"count": "",
"id": 5345980119515136,
"domain": "prabathk",
"email": "[email protected]",
"is_admin": true,
"is_account_owner": true,
"is_disabled": false,
"email_template": "",
"name": "prabath kolipaka"
},
"contacts": [
],
"pic": "https://s3.amazonaws.com/agilecrm/panel/uploaded-logo/1401427105618?id=upload-container"
}
],
Stage1: [
{
"cursor": "",
"count": "",
"id": 5193799529660416,
"name": " Nike Endorsement",
"contact_ids": [
],
"custom_data": [
],
"description": "Advertisements and apparel for Nike",
"expected_value": 2.0E11,
"pipeline_id" :"43535822",
"milestone": "Lost",
"probability": 98,
"close_date": 0,
"owner_id": "",
"created_time": 1402580362,
"track": "",
"entity_type": "deal",
"notes": [
],
"note_description": "",
"owner": {
"cursor": "",
"count": "",
"id": 5345980119515136,
"domain": "prabathk",
"email": "[email protected]",
"is_admin": true,
"is_account_owner": true,
"is_disabled": false,
"email_template": "",
"name": "prabath kolipaka"
},
"contacts": [
],
"pic": "https://s3.amazonaws.com/agilecrm/panel/uploaded-logo/1401427105618?id=upload-container"
}
]
}In this above example, Lost, Open, Won, Stage 1 are different milestones. These may vary depending on the user choice.
- Status 200: Successfully retrieved the deals list.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
Method: GET
- Fetches list of deals from the particular track grouped by milestones. Number of milestones depends upon the milestones added by user to that track. The track id has to be sent as a query parameter. If 0 is sent as the parameter, it will give the list of deals from the default track.
curl https://{domain}.agilecrm.com/dev/api/opportunity/byPipeline/based?pipeline_id=4756437 -H "Accept : application/json" -v -u {email} : {API Key}{
"Lost": [
{
"cursor": "",
"count": "",
"id": 5086100271923200,
"name": " Nike Endorsement",
"contact_ids": [
],
"custom_data": [
{
"name": "Ddate",
"value": "07/11/2014"
}
],
"description": "Advertisements and apparel for Nike",
"expected_value": 2000000.0,
"pipeline_id" :"4756437",
"milestone": "Lost",
"probability": 98,
"close_date": 1468800,
"owner_id": "",
"created_time": 1405085631,
"track": "",
"entity_type": "deal",
"notes": [
],
"note_description": "",
"owner": {
"cursor": "",
"count": "",
"id": 5345980119515136,
"domain": "prabathk",
"email": "[email protected]",
"is_admin": true,
"is_account_owner": true,
"is_disabled": false,
"email_template": "",
"name": "prabath kolipaka"
},
"contacts": [
],
"pic": "https://s3.amazonaws.com/agilecrm/panel/uploaded-logo/1401427105618?id=upload-container"
}
],
Open: [
{
"cursor": "",
"count": "",
"id": 5115435166990336,
"name": " test deal",
"contact_ids": [
],
"custom_data": [
{
"name": "Ddate",
"value": "07/23/2014"
}
],
"description": "testing",
"expected_value": 1235.0,
"pipeline_id" :"4756437",
"milestone": "Lost",
"probability": 123,
"close_date": 1405555200,
"owner_id": "",
"created_time": 1405518785,
"track": "",
"entity_type": "deal",
"notes": [
],
"note_description": "",
"owner": {
"cursor": "",
"count": "",
"id": 5345980119515136,
"domain": "prabathk",
"email": "[email protected]",
"is_admin": true,
"is_account_owner": true,
"is_disabled": false,
"email_template": "",
"name": "prabath kolipaka"
},
"contacts": [
],
"pic": "https://s3.amazonaws.com/agilecrm/panel/uploaded-logo/1401427105618?id=upload-container"
}
]
}In this above example, Lost, Open, Won, Stage 1 are different milestones. These may vary depending on the user choice.
- Status 200: Successfully retrieved the deals list.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
Method: GET
-
Fetches list of deals from the particular track. Number of milestones depends upon the milestones added by user to that track. The track id has to be sent as a query parameter.
- If 0 is sent as the parameter, it will give the list of deals from the default track.
- If 1 is sent as the parameter, it will give the list of all deals from all tracks.
Paging can be applied using the page_size and cursor query parameters. Count of the deal will be in the first deal and Cursor for the next page will be in the last deal of the list. If there is no cursor, it means that it is the end of list.
curl https://{domain}.agilecrm.com/dev/api/opportunity/based?pipeline_id=4756437&page_size=10&cursor=E-ABAIICNGoRc35hZ2lsZS1jcm0tY2xvdWRyFAsSB0NvbnRhY3QYgICAgKLThAoMogEIcHJhYmF0aGuIAgAU -H "Accept : application/json" -v -u {email} : {API Key}[
{
"cursor": "",
"count": "",
"id": 5086100271923200,
"name": " Nike Endorsement",
"contact_ids": [
],
"custom_data": [
{
"name": "Ddate",
"value": "07/11/2014"
}
],
"description": "Advertisements and apparel for Nike",
"expected_value": 2000000.0,
"pipeline_id" :"4756437",
"milestone": "Lost",
"probability": 98,
"close_date": 1468800,
"owner_id": "",
"created_time": 1405085631,
"track": "",
"entity_type": "deal",
"notes": [
],
"note_description": "",
"owner": {
"cursor": "",
"count": "",
"id": 5345980119515136,
"domain": "prabathk",
"email": "[email protected]",
"is_admin": true,
"is_account_owner": true,
"is_disabled": false,
"email_template": "",
"name": "prabath kolipaka"
},
"contacts": [
],
"pic": "https://s3.amazonaws.com/agilecrm/panel/uploaded-logo/1401427105618?id=upload-container"
},
{
"cursor": "",
"count": "",
"id": 5115435166990336,
"name": " test deal",
"contact_ids": [
],
"custom_data": [
{
"name": "Ddate",
"value": "07/23/2014"
}
],
"description": "testing",
"expected_value": 1235.0,
"pipeline_id" :"4756437",
"milestone": "Lost",
"probability": 123,
"close_date": 1405555200,
"owner_id": "",
"created_time": 1405518785,
"track": "",
"entity_type": "deal",
"notes": [
],
"note_description": "",
"owner": {
"cursor": "",
"count": "",
"id": 5345980119515136,
"domain": "prabathk",
"email": "[email protected]",
"is_admin": true,
"is_account_owner": true,
"is_disabled": false,
"email_template": "",
"name": "prabath kolipaka"
},
"contacts": [
],
"pic": "https://s3.amazonaws.com/agilecrm/panel/uploaded-logo/1401427105618?id=upload-container"
}
] In this above example, Lost, Open, Won, Stage 1 are different milestones. These may vary depending on the user choice.
- Status 200: Successfully retrieved the deals list.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
Method: GET
- Fetches list of deals related to specified contact using the contact id.
curl https://{domain}.agilecrm.com/dev/api/contacts/{contact_id}/deals -H "Accept : application/json" -v -u {email} : {API Key}[
{
"id" : 822,
"name" : "Game Development",
"created_time" : 1356325843,
"contacts" : [
{
id : "445",
created_time : 1356315843
…
}
...
]
…
},
{
"id" : 850,
"name" : "Product Design",
"created_time" : "1357794282",
…
},
...
]- Status 200: Successfully retrieved the deals list.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
Method: GET
- Fetches list of deals of the current user
curl https://{domain}.agilecrm.com/dev/api/opportunity/my/deals -H "Accept : application/json" -v -u {email} : {API Key}[
{
"id" : 822,
"name" : "Game Development",
"created_time" : 1356325843,
"contacts" : [
{
id : "445",
created_time : 1356315843
…
}
...
]
...
},
{
"id" : 850,
"name" : "Product Design",
"created_time" : "1357794282",
…
},
...
]- Status 200: Successfully retrieved the deals list.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
Method: PUT
We can update deal using this call. It accepts Deal JSON. Id parameter of the deal should be specified. This will not affect other fields.
{
"id": "6429943999234048",
"contact_ids": [
"4930210138947584",
"4600356650614784"
]
}curl https://{domain}.agilecrm.com/dev/api/opportunity/partial-update/delete-contact \
-H "Accept : application/json" \
-H "Content-Type: application/json" \
-d '{
"id": "6429943999234048",
"contact_ids": [
"4930210138947584",
"4600356650614784"
]
}' \
-v -u [email protected]:your_rest_api -X PUT- Status 200: Deal updated successfully. Returns the updated deal object in the response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format.
- Notes API
| Field Name | Description | Value Type | Read Only | Mandatory | Accepted values |
|---|---|---|---|---|---|
| id | Unique id generated when note is created | Long | no | no | N/A |
| created_time | Creation time of note | Long | yes | no | epoch time |
| subject | Subject of the note | String | no | yes | N/A |
| description | Description of note | String | no | yes | N/A |
| contact_json | list of contact ids | String array | no | no | N/A |
Method: POST
- Creates a note and relates it to contacts, which are sent in the note JSON contact field.
curl https://{domain}.agilecrm.com/dev/api/notes/ \
-H "Content-Type : application/json" \
-H "Accept : application/json" \
-d '{
"subject": " Note subject",
"description": "Note description",
"contact_ids": [
"5688267051630592",
"5721389839417344"
]
}' \
-v -u {email} : {APi Key} -X POST {
"id" : 5688267051630500,
"created_time" : 1360561958,
"subject" : "Note subject",
"description" : "Note description",
"entity_type" : "note"
}- Status 200: Note added successfully and it returns the newly created note as JSON in response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
Method: POST
- Adds a note to the contact with given Email-ID. Email address and the note object should be sent as url-encoded form parameters to the above given URL.
curl https://{domain}.agilecrm.com/dev/api/contacts/email/note/add -H "Accept: application/json" \
-H "Content-Type :application/x-www-form-urlencoded" \
-d '[email protected]¬e={"subject":"test","description":"testing description"}' \
-v -u {email}:{apikey} -X POST- Status 204: Note added successfully.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format.
Method: GET
- Returns list of note JSONs related to the contact.
curl https://{domain}.agilecrm.com/dev/api/contacts/5688267051630592/notes -H "Accept : application/json" -v -u {email} : {API Key}[
{
"count": 2,
"id": 5757434010271744,
"created_time": 1456469393,
"subject": "Tata",
"description": "Product Famous in India",
"contact_ids": [
"5748927693324288"
],
"contacts": [
{
"id": 5748927693324288,
"type": "PERSON",
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "olay"
}
]
}
]
},
{
"id": 5725589243691008,
"created_time": 1456469284,
"subject": "toyta",
"description": "Product's related to worldwide.",
"contact_ids": [
"5748927693324288"
],
"contacts": [
{
"id": 5748927693324288,
"type": "PERSON",
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "olay"
}
]
}
]
}
]Method: DELETE - Deletes the note of the specific contact. (It will remove the relationship between the note and the contact.)
curl https://{domain}.agilecrm.com/dev/api/contacts/{contact_id}/notes/{note_id} -H "Accept : application/json" -v -u {email} : {API Key} -X DELETE- Status 204: Note removed successfully.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
Method: POST
- Accepts note JSON as data in Post request to the url specified above, which creates new note and returns the note JSON with id field generated when new note is created.
{
"subject": "Deal From Albany",
"description": "This deal came directly from customer. No advertisement and hence very important for us.",
"deal_ids": [
"5088304026353664"
]
}curl https://{domain}.agilecrm.com/dev/api/opportunity/deals/notes \
-H "Accept :application/json" \
-H "Content-Type: application/json" \
-d '{
"subject": "Deal From Albany",
"description": "This deal came directly from customer. No advertisement and hence very important for us.",
"deal_ids": [
"5088304026353664"
]
}' \
-v -u {email}:{apikey} -X POST - Status 200: Note added successfully and it returns the deal as JSON in response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
Method: PUT
- Accepts note JSON as data in Post request to the url specified above, which update note and returns the deal JSON with id field generated when new note is created.
{
"id": "5714548224950272",
"subject": "Deal From Albany edit",
"description": "This deal came directly from customer. No advertisement and hence very important for us.",
"deal_ids": [
"5088304026353664"
]
}curl https://{domain}.agilecrm.com/dev/api/opportunity/deals/notes \
-H "Accept :application/json" \
-H "Content-Type: application/json" \
-d '{
"id": "5714548224950272",
"subject": "Deal From Albany Edit",
"description": "This deal came directly from customer. No advertisement and hence very important for us.",
"deal_ids": [
"5088304026353664"
]
}' \
-v -u {email}:{apikey} -X PUT- Status 200: Note updated successfully and it returns the deal as JSON in response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
Method: GET
- Returns list of note JSONs related to the contact.
curl https://{domain}.agilecrm.com/dev/api/opportunity/{deal-id}/notes -H "Accept : application/json" -v -u {email} : {API Key}[
{
"id": 5702534932987904,
"created_time": 1456467295,
"subject": "Deal From Albany",
"description": "This deal came directly from customer. No advertisement and hence very important for us.",
"entity_type": "note"
},
{
"id": 5714548224950272,
"created_time": 1456468655,
"subject": "Deal From Albany edit 1234",
"description": "This deal came directly from customer. No advertisement and hence very important for us.",
"contact_ids": [],
"deal_ids": []
}
]- Status 200: Returned list od notes
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
Method: POST - Deletes notes of the specific deal.
curl https://{domain}.agilecrm.com/dev/api/contacts/notes/bulk -H "Accept: application/json" \
-H "Content-Type :application/x-www-form-urlencoded" \
-d 'ids=["5641751750508544"]' \
-v -u {email}:{apikey} -X POST- Status 204: Note removed successfully.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
| Field Name | Description | Value Type | Read Only | Mandatory | Accepted values |
|---|---|---|---|---|---|
| id | Unique id generated when task is created | Long | no | no | N/A |
| type | Determines the type to which the task belongs. The type should be in the given list. It is case sensitive. It should only be specified as mentioned here - | String | no | yes | CALL, EMAIL, FOLLOW_UP, MEETING, MILESTONE, SEND, TWEET, OTHER. |
| priority_type | Determines the priority of the task. It is case sensitive. It should only be specified as mentioned here. | String | no | yes | There are 3 kinds of priorities - HIGH, NORMAL, LOW. |
| due | Due date of the task. It should be specified as Epoch Time. | Long | no | yes | Epoch time |
| created_time | Creation time of task | Long | yes | no | Epoch time |
| is_complete | Determines whether the task is completed or not. If completed, then true. Else, false. | Boolean | no | no | true/false |
| contacts | List of contacts related to the task. While saving, the contact ids have to be given as a string array to relate them to the task. | String array | no | no | ID’s of the contacts. |
| subject | Subject of the task. | String | no | yes | N/A |
| entity_type | It is a read only variable. Its value is ‘task’ always. | String | yes | no | task |
| notes | It is the list of notes related to this task. While adding or editing a task, the list of note id’s has to be sent as a string array in order to save them. | String array | no | no | N/A |
| progress | It is used to determine the progress of the task. (0-100%) | Int | no | no | 0 to 100 |
| status | Determines the status of the task. | String | no | no | YET_TO_START, IN_PROGRESS, COMPLETED. These are case sensitive. |
| taskOwner | It has the information about the owner of the task. | JSON object | yes | no | N/A |
| owner_id | lId of the user who is the owner of the task. Send this field in the task object while adding or updating the task in order to assign the task to the owner. | Long | no | no | Id of the user(Owner) |
Method: GET
- Retrieve the pending tasks of all the users which are ‘num-days’ days away from the due date. It will return the list of tasks as a JSON Array.
curl https:{domain}.agilecrm.com/dev/api/tasks/pending/3 -H "Accept:application/json" -v -u {email}:{API Key}- Status 200: Gets the list of tasks.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
[
{
"id": 5149503652888576,
"type": "EMAIL",
"priority_type": "HIGH",
"due": -19800,
"created_time": 1409649528,
"is_complete": false,
"contacts": [
{
"id": 5704147139559424,
"type": "PERSON",
"created_time": 1398421585,
"updated_time": 1406619697,
...
}
],
"subject": "Contact created in agile crm",
"entity_type": "task",
"notes": [
],
"progress": 0,
"status": "YET_TO_START",
"taskOwner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "[email protected]",
"is_admin": true,
...
},
{
"id": 5176288276905984,
"type": "EMAIL",
"priority_type": "LOW",
"due": -19800,
"created_time": 1409649695,
"is_complete": false,
"contacts": [
{
"id": 5704147139559424,
"type": "PERSON",
"created_time": 1398421585,
"updated_time": 1406619697,
...
}
],
"subject": "Contact created in agile crm",
"entity_type": "task",
"notes": [
],
"progress": 0,
"status": "YET_TO_START",
"taskOwner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "[email protected]",
...
}
]Method: GET
- Retrives the list of tasks based on the given filters. The filters available are ‘type’, ‘owner’, ’pending’, ‘criteria’, and ‘page_size’. These should be sent as a query parameters in the URL.
- There are three criteria can be use using this api and each has its own type.
- criteria = CATEGORY has these type (EMAIL,CALL,FOLLOW_UP,MEETING,MILESTONE,SEND,TWEET,OTHER)
- criteria = STATUS has these type (IN_PROGRESS,YET_TO_START,COMPLETED)
- criteria = PRIORITY has these type (HIGH,NORMAL,LOW)
Paging can be applied using the page_size and cursor query parameters. Count of the tasks will be in the first task and Cursor for the next page will be in the last task of the list. If there is no cursor, it means that it is the end of list.
curl https:{domain}.agilecrm.com/dev/api/tasks/based?pending=true&criteria=CATEGORY&type=EMAIL&page_size=10&cursor=E-ABAIICNGoRc35hZ2lsZS1jcm0tY2xvdWRyFAsSB0NvbnRhY3QYgICAgKLThAoMogEIcHJhYmF0aGuIAgAU -H "Accept:application/json" -v -u {email}:{API Key}- Status 200: Gets the list of tasks.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
[
{
"id": 5149503652888576,
"type": "EMAIL",
"priority_type": "HIGH",
"due": -19800,
"created_time": 1409649528,
"is_complete": false,
"contacts": [
{
"id": 5704147139559424,
"type": "PERSON",
"created_time": 1398421585,
"updated_time": 1406619697,
...
}
],
"subject": "Contact created in agile crm",
"entity_type": "task",
"notes": [
],
"progress": 0,
"status": "YET_TO_START",
"taskOwner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "[email protected]",
"is_admin": true,
...
},
{
"id": 5176288276905984,
"type": "EMAIL",
"priority_type": "LOW",
"due": -19800,
"created_time": 1409649695,
"is_complete": false,
"contacts": [
{
"id": 5704147139559424,
"type": "PERSON",
"created_time": 1398421585,
"updated_time": 1406619697,
...
}
],
"subject": "Contact created in agile crm",
"entity_type": "task",
"notes": [
],
"progress": 0,
"status": "YET_TO_START",
"taskOwner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "[email protected]",
...
}
]Method: GET
- Gets the task of the contact with the given ID.
curl https:{domain}.agilecrm.com/dev/api/tasks/{task-id} -H "Accept:application/json" -v -u {email}:{API Key}- Status 200: Gets the list of tasks.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
{
"id": 5149503652888576,
"type": "EMAIL",
"priority_type": "HIGH",
"due": -19800,
"created_time": 1409649528,
"is_complete": false,
"contacts": [
{
"id": 5704147139559424,
"type": "PERSON",
"created_time": 1398421585,
"updated_time": 1406619697,
...
}
],
"subject": "Contact created in agile crm",
"entity_type": "task",
"notes": [
],
"progress": 0,
"status": "YET_TO_START",
"taskOwner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "[email protected]",
"is_admin": true,
...
}Method: POST
- Creates a new task.
- Acceptable value for below field :
progress (0 to 100), is_complete (true or false), type (CALL, EMAIL, FOLLOW_UP, MEETING, MILESTONE, SEND, TWEET, OTHER),
priority_type (HIGH, NORMAL, LOW), status (YET_TO_START, IN_PROGRESS, COMPLETED)
{
"progress": "0",
"is_complete": "false",
"subject": "Need to contact vendor",
"type": "MEETING",
"due": 1459319400,
"task_ending_time": "12:00",
"owner_id": "6263975862861824",
"priority_type": "HIGH",
"status": "YET_TO_START",
"taskDescription": "This is very important. We need to discuss with few vendors about the product.",
"contacts": [
"5719430394806272"
],
"notes": [
"5715549623418880"
],
"deal_ids": [
"5715549623415649"
]
}curl https://{domain}.agilecrm.com/dev/api/tasks \
-H "Accept : application/json" \
-H "Content-Type: application/json" \
-d '{
"progress": "0",
"subject": "Need to contact",
"type": "EMAIL",
"due": 1456986600,
"task_ending_time": "12:00",
"priority_type": "HIGH",
"status": "YET_TO_START",
"contacts": [
"5725836472745984"
]
}' \
-v -u [email protected]:123456 -X POST- Status 200: Task added successfully and it returns the newly created task as JSON in response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
{
"id": 5149503652888576,
"type": "EMAIL",
"priority_type": "HIGH",
"due": 11545245654,
"created_time": 1409649528,
"is_complete": false,
"contacts": [
{
"id": 5704147139559424,
"type": "PERSON",
"created_time": 1398421585,
"updated_time": 1406619697,
...
}
],
"subject": "test",
"entity_type": "task",
"notes": [
],
"progress": 0,
"status": "YET_TO_START",
"taskOwner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "[email protected]",
"is_admin": true,
...
}Method: POST
- Creates a new task and relates it to the contact having the email.
curl https://{domain}.agilecrm.com/dev/api/tasks/email/[email protected] \
-H "Accept : application/json" \
-H "Content-Type: application/json" \
-d '{
"subject": "Need to contact1",
"type": "EMAIL",
"due": 1456986600,
"task_ending_time": "12:00",
"priority_type": "HIGH",
"status": "YET_TO_START"
}' \
-v -u [email protected]:123456 -X POST- Status 200: Task added successfully and it returns the newly created task as JSON in response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
{
"id": 5149503652888576,
"type": "EMAIL",
"priority_type": "HIGH",
"due": 11545245654,
"created_time": 1409649528,
"is_complete": false,
"contacts": [
{
"id": 5704147139559424,
"type": "PERSON",
"created_time": 1398421585,
"updated_time": 1406619697,
...
}
],
"subject": "test",
"entity_type": "task",
"notes": [
],
"progress": 0,
"status": "YET_TO_START",
"taskOwner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "[email protected]",
"is_admin": true,
...
}Method: PUT
We can update task using this call. It accepts task JSON. Id parameter of the task should be specified. This will not affect other fields.
{
"id": "6097891487645696",
"subject": "sample",
"type": "EMAIL"
"due": 1448941500,
"contacts": [
"5700328880078848",
"6487118603878400"
]
}curl https://{domain}.agilecrm.com/dev/api/tasks/partial-update \
-H "Accept : application/json" \
-H "Content-Type: application/json" \
-d '{
"id": "5690477483393024",
"subject": "sample edit",
"type": "EMAIL",
"due": 1448941500,
"contacts": [
"5725836472745984",
"6487118603878400"
]
}' \
-v -u [email protected]:123456 -X PUT- Status 200: Task updated successfully. Returns the updated task object in the response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format.
Method: DELETE
- Deletes the task having the given ID.
curl https:{domain}.agilecrm.com/dev/api/tasks/5149503652888576 -H "Accept:application/json" -v -u {email}:{API Key} -X DELETE- Status 204: Task deleted successfully.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
Method: GET
- Returns list of all "Tasks" in the domain in JSON format, which are ordered by created time.
curl https:{domain}.agilecrm.com/dev/api/tasks -H "Accept:application/json" -v -u {email}:{API Key} -X GET- Status 204: Successfully retrieved the Tasks list.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
Method: GET
- Retrieves the tasks related to contact, sorted by the date (latest first.).
curl https://{domain}.agilecrm.com/dev/api/contacts/{contact_id}/tasks/sort -H "Accept: application/json" -v -u {email}:{apikey}- Status 200: Returns the tasks list related to the contact.
[
{
"id": 5152971570544640,
"type": "EMAIL",
"priority_type": "NORMAL",
"due": 1409596200,
"created_time": 1409567774,
"is_complete": false,
"contacts": [
{
"id": 5716606839685120,
"type": "PERSON",
"created_time": 1403057154,
"updated_time": 1403057154,
"viewed_time": 0,
"viewed": {
"viewed_time": 1409567737463,
"viewer_id": 5345980119515136
},
"star_value": 0,
"lead_score": 0,
"tags": [],
"tagsWithTime": [],
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "Basecamp (2Desk)"
},
{
"type": "SYSTEM",
"name": "last_name",
"value": "Basecamp (2Desk)"
},
{
"type": "SYSTEM",
"name": "email",
"value": "[email protected]"
}
],
"campaign- Status": [],
"entity_type": "contact_entity",
"unsubscribe- Status": [],
"emailBounce- Status": [],
"owner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "[email protected]",
"is_admin": true,
"is_account_owner": true,
"is_disabled": false,
"name": "prabath kolipaka"
}
}
],
"subject": "Contact created in agile crm",
"entity_type": "task",
"notes": [],
"progress": 0,
"- Status": "YET_TO_START",
"ownerPic": "https://s3.amazonaws.com/agilecrm/panel/uploaded-logo/1401427105618?id=upload-container",
"taskOwner": {
"id": 5345980119515136,
"domain": "prabathk",
"email": "[email protected]",
"is_admin": true,
"is_account_owner": true,
"is_disabled": false,
"name": "prabath kolipaka"
}
}
]- Status 401: Unauthorised. (when the user name and password fields are wrong.)
| Field Name | Description | Value Type | Read Only | Mandatory | Accepted Values |
|---|---|---|---|---|---|
| id | Unique id generated when event is created | Long | no | no | |
| created_time | Creation time of Event | Long | yes | no | Epoch time |
| allDay | Determines whether the event lasts for the whole day or not. | Boolean | no | no | true / false |
| contacts | List of contacts related to the event. While saving, the contact ids have to be given as a string array to relate them to the event. | String array | no | no | ID’s of the contacts |
| title | Title of the event | String | no | yes | N/A |
| color | Color states the priority of the event. | The colors are case sensitive. All of them should be specified in the same case. | String | no | no |
| start | Start time of Event in epoch time format. | Long | no | yes | epoch time |
| end | End time of Event in epoch time format. | Long | no | yes | epoch time |
| is_event_starred | It determines whether the particular event is starred or not. | Boolean | no | no | true / false |
Method: GET
- Fetches the list of events happened in particular time. The start time and end time have to be sent in epoch format as query parameters.
curl https:{domain}.agilecrm.com/dev/api/events?start=1409423400&end=1413052200 -H "Accept:application/json" -v -u {email}:{API Key}
- Status 200: Gets the list of events.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
[
{
"id": 5758048710688768,
"start": 1409682600,
"end": 1409768100,
"is_event_starred": false,
"allDay": true,
"title": "Today Test event",
"color": "red",
"created_time": 1409569472,
"contacts": [
{
"id": 5716606839685120,
"type": "PERSON",
"star_value": 0,
"lead_score": 0,
"tags": [],
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "Basecamp (2Desk)"
},
...
],
...
}
]
},
{
"id": 5740240702537728,
"start": 1409769000,
"end": 1409855340,
"is_event_starred": false,
"allDay": false,
"title": "tlest",
"color": "green",
"created_time": 1410421808,
"contacts": [
{
"id": 5727217287954432,
"type": "PERSON",
"star_value": 0,
"lead_score": 1,
"tags": [
" mobile",
"test"
],
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "test first"
}
...
],
...
}
]
}
]Method: GET
- Retrieves the events related to contact sorted by date.
curl https://{domain}.agilecrm.com/dev/api/contacts/{contact_id}/events/sort -H "Accept: application/json" -v -u {email}:{apikey}- Status 200: Returns the events list related to the contact.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
[
{
"id": 5758048710688768,
"start": 1409682600,
"end": 1409768100,
"is_event_starred": false,
"allDay": true,
"title": "Today Test event",
"color": "red",
"created_time": 1409569472,
"contacts": [
{
"id": 5716606839685120,
"type": "PERSON",
…...
}
]
}
]Method: POST
- Creates an event.
curl https://{domain}.agilecrm.com/dev/api/events -H "Content-Type : application/json" -H "Accept : application/json" -d ‘{"title" : "Today Test event" , "allDay" : true, "color" : "red" , "start":1409682600,"end":1409768100, "contacts" : ["721001", "722001"] }’ -v -u {email} : {API Key} -X POST {
"id": 5758048710688768,
"start": 1409682600,
"end": 1409768100,
"is_event_starred": false,
"allDay": true,
"title": "Today Test event",
"color": "red",
"created_time": 1409569472,
"contacts": [
{
"id": 721001,
"type": "PERSON",
...
}
]
}- Status 200: Event added successfully and it returns the newly created event as JSON in response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
Method: PUT
- Updates an event. To update the event, the event id has to be provided in the request object. Otherwise, it will be considered as a new event.
curl https://{domain}.agilecrm.com/dev/api/events -H "Content-Type : application/json" -H "Accept : application/json" -d ‘{"id": 5758048710688768, "title" : "Today Test event" , "allDay" : true, "color" : "red" , "start":1409682600,"end":1409768100, "contacts" : ["721001", "722001"] }’ -v -u {email} : {API Key} -X PUT {
"id": 5758048710688768,
"start": 1409682600,
"end": 1409768100,
"is_event_starred": false,
"allDay": true,
"title": "Today Test event",
"color": "red",
"created_time": 1409569472,
"contacts": [
{
"id": 721001,
"type": "PERSON",
...
}
]
}- Status 200: Event updated successfully and it returns the updated event as JSON in response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
Method: DELETE
- Deletes the event with the particular id. The id passed in the url will be used to identify the event.
curl https:{domain}.agilecrm.com/dev/api/events/5149503652888576 -H "Accept:application/json" -v -u {email}:{API Key} -X DELETE- Status 204: Event deleted successfully.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Track / Milestones API
| Field Name | Description | Value Type | Read Only | Mandatory | Accepted values |
|---|---|---|---|---|---|
| id | Unique id generated when Track is created | Long | no | no | N/A |
| name | Name of the track | String | no | yes | N/A |
| milestones | Comma separated strings. Each string is a milestone and these are case sensitive. All of them should be specified in the same case. The first letter of the track needs to be specified in upper case. | String | no | yes | N/A |
Method: GET
- Gets all the tracks. Each track will be having a set of milestones.
curl https://{domain}.agilecrm.com/dev/api/milestone/pipelines -H "Accept: application/xml" -v -u {email}:{apikey}- Status 200: Returns the events list related to the contact.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
[
{
"id": 5146448186310656,
"milestones": "Open,New,Prospect,Proposal,Won,Lost",
"name": "Default"
}
]Method: POST
- Creates a track. Name should not be "Default". Milestone fields should be a single string - a group of multiple strings separated by comma. First letter of all the milestones should be in uppercase.
```sh` curl https://{domain}.agilecrm.com/dev/api/milestone/pipelines -H "Content-Type : application/json" -H "Accept : application/json" -d ‘{"name" : "Test" , "milestones" : "Open,New,Prospect,Proposal,Won,Lost" }’ -v -u {email} : {API Key} -X POST
### Example Response:
```javascript
{
"id": 5146448186310656,
"milestones": "Open,New,Prospect,Proposal,Won,Lost",
"name": "Default"
}
- Status 200: Track created successfully and it returns the newly created track as JSON in response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
Method: PUT
- Updates a track. Name should not be "Default". Milestone fields should be a single string - group of multiple strings separated by comma. First letter all the milestones should be in uppercase. The Id of the track needs to be specified in the request json to update the track. Otherwise, it will be considered as a new track.
curl https://{domain}.agilecrm.com/dev/api/milestone/pipelines -H "Content-Type : application/json" -H "Accept : application/json" -d ‘{"id": 5146448186310656,
"name" : "Test" , "milestones" : "Open,New,Prospect,Proposal,Won,Lost" }’ -v -u {email} : {API Key} -X PUT {
"id": 5146448186310656,
"milestones": "Open,New,Prospect,Proposal,Won,Lost",
"name": "Default"
}- Status 200: Track updated successfully and it returns the updated track as JSON in response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
Method: DELETE
- Deletes the track with the particular id. The id passed in the url will be used to identify the track.
curl https:{domain}.agilecrm.com/dev/api/milestone/pipelines/5149503652888576 -H "Accept:application/json" -v -u {email}:{API Key} -X DELETE- Status 204: Track deleted successfully.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
Method: GET
- Returns a list of campaigns
For the Response in the XML format, add the header 'Accept' as application/xml. By default, the response will be in XML format. Paging can be applied using the page_size and cursor query parameters.
curl https://{domain}.agilecrm.com/dev/api/workflows?page_size=20&cursor=E-ABAIICNGoRc35hZ2lsZS1jcm0tY2xvdWRyFAsSB0NvbnRhY3QYgICAgKLThAoMogEIcHJhYmF0aGuIAgAU -H "Accept : application/json" -v -u {email}:{apikey}{
id: 5727517264576512
name: "letter head"
created_time: 1437996248
updated_time: 0
rules: "{"nodes":[{"NodeDefinition":{"name":"Start","thumbnail":"json/nodes/images/common/Start.png","icon":"json/no des/icons/common/Start.png","info":"Entry point of your campaign. Please create workflow for your campaign starting from here.","help":"Start point in your campaign .... Action</td>\r\n</tr>\r\n</tbody>\r\n</table>\r\n</td>\r\n</tr>\r\n</tbody>\r\n</table>\r\n</td>\r\n</tr>\ r\n<tr>\r\n<td align=\"center\" valign=\"top\">\r\n<table style=\"border-collapse: collapse !important; width: 100%;\" border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\r\n<tbody>\r\n<tr>\r\n<td style=\"color: #606060; font-family: Helvetica,Arial,sans-serif; font-size: 13px; line-height: 125%;\" align=\"center\" valign=\"top\">\r\n<p style=\"margin: -5px;\"><img style=\"vertical-align: middle;\" src=\"https://www.MYSITE.com/logo.png\" alt=\"\" /> Your Caption</p>\r\n<p style=\"margin: 10px;\"><a style=\"padding: 6px; color: black; border: none;\" href=\"https://twitter.com/agile_crm\" target=\"_blank\"><img style=\"border: none;\" src=\"https://www.agilecrm.com/img/twitter-icon.png\" alt=\"twitter\" /></a> <a style=\"padding: 6px; border: none;\" href=\"https://www.facebook.com/CRM.Agile\" target=\"_blank\"><img style=\"border: none;\" src=\"https://www.agilecrm.com/img/facebook-icon.png\" alt=\"fb\" /></a> <a style=\"padding: 6px; border: none;\" href=\"https://plus.google.com/109484059291748745615/posts\" target=\"_blank\"><img style=\"border: none;\" src=\"https://www.agilecrm.com/img/googleplus-icon.png\" alt=\"gplus\" /></a></p>\r\n<p><a href=\"https://www.agilecrm.com\" target=\"_blank\">www.mysite.com</a></p>\r\n</td>\r\n</tr>\r\n<tr>\r\n<td align=\"center\" valign=\"top\"> </td>\r\n</tr>\r\n</tbody>\r\n</table>\r\n</td>\r\n</tr>\r\n</tbody>\r\n</table>\r\n</td>\r\n</tr>\r\n</tbody>\r\n</table>\r\n</center></div>"},{"name":"track_clicks","value":"yes"},{"name":"purl_keyword","value":""},{"name":"time_zone","value":"ACT"},{"name":"on","value":"any_day"},{"name":"at","value":"any_time"}],"States":[{"yes":"hangup"}]}]}"
unsubscribe: {
action: "ASK_USER"
tag: ""
unsubscribe_email: ""
}-
domainUserId: 5609297576722432
creatorName: "ghanshyam"
}- Status 200: Successfully retrieved the campaign list.
- Status 401: Unauthorized. (When the user name and password fields are wrong.)
Method: GET
- Returns list of documents in the JSON format related to the contact.
curl https://{domain}.agilecrm.com/dev/api/documents/contact/5668302869233664/docs -H "Accept : application/json" -v -u {email} : {API Key}[
{
"count": 2,
"id": 5757434010271744,
"created_time": 1456469393,
"subject": "Tata",
"description": "Product Famous in India",
[
{
"id": 5765788359196672,
"name": "tester",
"dummy_name": "tester",
"uploaded_time": 1489466749,
"extension": "getcontactlogs.PNG",
"doc_type": "ATTACHMENT",
"text": "",
"template_type": "",
"size": 92293,
"network_type": "S3",
"url": "https://s3.amazonaws.com/agilecrm/panel/uploaded-logo/ghanshyam/1489466715191/getcontactlogs.PNG?id=uploadDocumentForm",
"entity_type": "document",
"contact_ids": [
"5668302869233664"
],
"case_ids": [],
"deal_ids": [],
"owner": {
"id": 6263975862861824,
"domain": "ghanshyam",
"email": "sample@*****.com",
"phone": "",
"name": "Ghanshyam",
"pic": "https://d1gwclp1pmzk26.cloudfront.net/img/gravatar/71.png",
"schedule_id": "Ghanshyam",
"calendar_url": "https://ghanshyam.agilecrm.com/calendar/Ghanshyam",
"calendarURL": "https://ghanshyam.agilecrm.com/calendar/Ghanshyam"
},
"relatedContacts": [
{
"id": 5668302869233664,
"type": "PERSON",
"created_time": 1488774702,
"updated_time": 1489549911,
"last_contacted": 0,
"last_emailed": 0,
"last_campaign_emaild": 0,
"last_called": 0,
"viewed_time": 0,
"viewed": {
"viewed_time": 1489549676825,
"viewer_id": 6263975862861824
},
"star_value": 0,
"lead_score": 0,
"klout_score": "",
"tags": [],
"tagsWithTime": [],
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "Make"
},
{
"type": "SYSTEM",
"name": "last_name",
"value": "hiksn"
},
{
"type": "SYSTEM",
"name": "email",
"value": "make@hikson"
},
{
"type": "SYSTEM",
"name": "title",
"value": "Developer"
}
],
"campaignStatus": [],
"entity_type": "contact_entity",
"source": "manual",
"unsubscribeStatus": [],
"emailBounceStatus": [],
"formId": 0,
"browserId": [],
"lead_source_id": 0,
"lead_status_id": 0,
"is_lead_converted": false,
"lead_converted_time": 0,
"is_duplicate_existed": false,
"owner": {
"id": 6263975862861824,
"domain": "ghanshyam",
"email": "sample@*****.com",
"phone": "",
"name": "Ghanshyam",
"pic": "https://d1gwclp1pmzk26.cloudfront.net/img/gravatar/71.png",
"schedule_id": "Ghanshyam",
"calendar_url": "https://ghanshyam.agilecrm.com/calendar/Ghanshyam",
"calendarURL": "https://ghanshyam.agilecrm.com/calendar/Ghanshyam"
}
}
],
"contacts": [
{
"id": 5668302869233664,
"type": "PERSON",
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "make"
},
{
"type": "SYSTEM",
"name": "last_name",
"value": "hiksn"
},
{
"type": "SYSTEM",
"name": "name",
"value": ""
}
]
}
],
"deals": []
},
{
"id": 5769954477473792,
"name": "Address proof",
"dummy_name": "address proof",
"uploaded_time": 1489549911,
"extension": "chrome-window2.PNG",
"doc_type": "ATTACHMENT",
"text": "",
"template_type": "",
"size": 57907,
"network_type": "S3",
"url": "https://s3.amazonaws.com/agilecrm/panel/uploaded-logo/ghanshyam/1489549880850/chrome-window2.PNG?id=uploadDocumentForm",
"entity_type": "document",
"contact_ids": [
"5668302869233664"
],
"case_ids": [],
"deal_ids": [
"6238333076242432"
],
"owner": {
"id": 6263975862861824,
"domain": "ghanshyam",
"email": "sample@*****.com",
"phone": "",
"name": "Ghanshyam",
"pic": "https://d1gwclp1pmzk26.cloudfront.net/img/gravatar/71.png",
"schedule_id": "Ghanshyam",
"calendar_url": "https://ghanshyam.agilecrm.com/calendar/Ghanshyam",
"calendarURL": "https://ghanshyam.agilecrm.com/calendar/Ghanshyam"
},
"relatedContacts": [
{
"id": 5668302869233664,
"type": "PERSON",
"created_time": 1488774702,
"updated_time": 1489549911,
"last_contacted": 0,
"last_emailed": 0,
"last_campaign_emaild": 0,
"last_called": 0,
"viewed_time": 0,
"viewed": {
"viewed_time": 1489549912557,
"viewer_id": 6263975862861824
},
"star_value": 0,
"lead_score": 0,
"klout_score": "",
"tags": [],
"tagsWithTime": [],
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "Make"
},
{
"type": "SYSTEM",
"name": "last_name",
"value": "hiksn"
},
{
"type": "SYSTEM",
"name": "email",
"value": "make@hikson"
},
{
"type": "SYSTEM",
"name": "title",
"value": "Developer"
}
],
"campaignStatus": [],
"entity_type": "contact_entity",
"source": "manual",
"unsubscribeStatus": [],
"emailBounceStatus": [],
"formId": 0,
"browserId": [],
"lead_source_id": 0,
"lead_status_id": 0,
"is_lead_converted": false,
"lead_converted_time": 0,
"is_duplicate_existed": false,
"owner": {
"id": 6263975862861824,
"domain": "ghanshyam",
"email": "sample@*****.com",
"phone": "",
"name": "Ghanshyam",
"pic": "https://d1gwclp1pmzk26.cloudfront.net/img/gravatar/71.png",
"schedule_id": "Ghanshyam",
"calendar_url": "https://ghanshyam.agilecrm.com/calendar/Ghanshyam",
"calendarURL": "https://ghanshyam.agilecrm.com/calendar/Ghanshyam"
}
}
],
"contacts": [
{
"id": 5668302869233664,
"type": "PERSON",
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "make"
},
{
"type": "SYSTEM",
"name": "last_name",
"value": "hiksn"
},
{
"type": "SYSTEM",
"name": "name",
"value": ""
}
]
}
],
"deals": [
{
"id": 6238333076242432,
"name": "ghansu deal"
}
]
}
]Method: POST
- Creates a new document with the link attached.
- url is mandatory filed.You have to provide link of a file it can be your local or server location.
{
"extension": "chrome-window2.PNG",
"doc_type": "ATTACHMENT",
"name": "Address proof",
"url": "https://s3.amazonaws.com/agilecrm/panel/uploaded-logo/ghanshyam/1489549880850/chrome-window2.PNG?id=uploadDocumentForm",
"size": "57907",
"network_type": "S3",
"contact_ids": [
"5735113836986368"
],
"deal_ids": [
"6238333076242432"
]
}curl https://{domain}.agilecrm.com/dev/api/documents \
-H "Accept : application/json" \
-H "Content-Type: application/json" \
-d '{
"extension": "chrome-window2.PNG",
"doc_type": "ATTACHMENT",
"name": "Address proof",
"url": "https://s3.amazonaws.com/agilecrm/panel/uploaded-logo/ghanshyam/1489549880850/chrome-window2.PNG?id=uploadDocumentForm",
"network_type": "S3",
"contact_ids": [
"5668302869233664"
],
"deal_ids": [
"6238333076242432"
]
}' \
-v -u [email protected]:123456 -X POST- Status 200: Document added successfully and it returns the newly created document as JSON in response.
- Status 401: Unauthorized (When the username and password provided in the respective fields are incorrect).
- Status 400: If the input is in wrong format
Method: PUT
- Update a new document with link attached.
- url is mandatory filed.You have to provide link of a file it can be your local or server location.
{
"id": "4823318989373440",
"extension": "chrome-window2.PNG",
"doc_type": "ATTACHMENT",
"name": "Address proof3",
"url": "https://s3.amazonaws.com/agilecrm/panel/uploaded-logo/ghanshyam/1489549880850/chrome-window2.PNG?id=uploadDocumentForm",
"contact_ids": [
"5735113836986368"
],
"deal_ids": [
"6238333076242432"
]
}curl https://{domain}.agilecrm.com/dev/api/documents \
-H "Accept : application/json" \
-H "Content-Type: application/json" \
-d '{
"id": "4823318989373440",
"extension": "chrome-window2.PNG",
"doc_type": "ATTACHMENT",
"name": "Address proof3",
"url": "https://s3.amazonaws.com/agilecrm/panel/uploaded-logo/ghanshyam/1489549880850/chrome-window2.PNG?id=uploadDocumentForm",
"contact_ids": [
"5735113836986368"
],
"deal_ids": [
"6238333076242432"
]
}' \
-v -u [email protected]:123456 -X PUT- Status 200: Document updated successfully and it returns the newly created document as JSON in response.
- Status 401: Unauthorized (When the username and password provided in the respective fields are incorrect).
- Status 400: If the input is in wrong format
Method: GET
- Returns list of JSON tickets.
curl https://{domain}.agilecrm.com/dev/api/tickets/filter?filter_id=5716987632156672&page_size=25&global_sort_key=-last_updated_time -H "Accept : application/json" -v -u {email} : {API Key}[
{
"id": 5,
"groupID": 5756098678095872,
"group": {
"id": 5756098678095872,
"group_name": "Support",
"group_email": "[email protected]"
},
"assigned_to_group": true,
"assigneeID": 6263975862861824,
"assigned_time": 1489653298291,
"assignee": {
"id": 6263975862861824,
"domain": "gsdr",
"email": "[email protected]",
"phone": "",
"name": "Ghanshyam",
"pic": "https://samplet.cloudfront.net/img/gravatar/71.png",
"schedule_id": "Ghanshyam",
"calendar_url": "https://samplet.agilecrm.com/calendar/Ghanshyam",
"calendarURL": "https://samplet.agilecrm.com/calendar/Ghanshyam"
},
"requester_name": "ghanshyam ",
"requester_email": "[email protected]",
"contactID": 5723745293434880,
"subject": "Test not working 11??",
"cc_emails": [
"[email protected]"
],
"created_time": 1489653298291,
"last_updated_time": 1489653298291,
"last_updated_by": "REQUESTER",
"last_customer_replied_time": 1489653298291,
"first_notes_text": "Hello I am testing your docs and find that Test is not working. Please help me",
"last_reply_text": "Hello I am testing your docs and find that Test is not working. Please help me",
"is_compressed": false,
"status": "OPEN",
"type": "PROBLEM",
"priority": "LOW",
"source": "EMAIL",
"created_by": "CUSTOMER",
"user_replies_count": 1,
"no_of_reopens": 0,
"attachments_exists": false,
"is_favorite": false,
"is_spam": false,
"requester_ip_address": "",
"html_text": "",
"entity_type": "tickets",
"attachments_list": [],
"labels": [],
"contact_ids": [],
"last_ticket_notes": {
"id": 6247474712805376,
"plain_text": "Hello I am testing your docs and find that Test is not working. Please help me",
"created_time": 1489653178798,
"ticket_notes_assinee": {
"id": 6263975862861824,
"domain": "ghanshyam",
"email": "[email protected]",
"phone": "",
"name": "Ghanshyam",
"pic": "https://d1gwclp1pmzk26.cloudfront.net/img/gravatar/71.png",
"schedule_id": "samplet",
"calendar_url": "https://samplet.agilecrm.com/calendar/san",
"calendarURL": "https://ghanshyam.agilecrm.com/calendar/san"
}
},
"contact": {
"id": 5723745293434880,
"type": "PERSON",
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "sder"
},
{
"type": "SYSTEM",
"name": "last_name",
"value": ""
},
{
"type": "SYSTEM",
"name": "name",
"value": ""
}
]
}
},
{
"id": 4,
"groupID": 5756098678095872,
"group": {
"id": 5756098678095872,
"group_name": "Support",
"group_email": "[email protected]"
},
"assigned_to_group": true,
"assigneeID": 6263975862861824,
"assigned_time": 1489653242528,
"assignee": {
"id": 6263975862861824,
"domain": "ghanshyam",
"email": "[email protected]",
"phone": "",
"name": "sdre",
"pic": "https://d1gwclp1pmzk26.cloudfront.net/img/gravatar/71.png",
"schedule_id": "Ghanshyam",
"calendar_url": "https://ghanshyam.agilecrm.com/calendar/dss",
"calendarURL": "https://ghanshyam.agilecrm.com/calendar/sdd"
},
"requester_name": "ghanshyam ",
"requester_email": "[email protected]",
"contactID": 5723745293434880,
"subject": "Test not working ??",
"cc_emails": [
"[email protected]"
],
"created_time": 1489653242528,
"last_updated_time": 1489653242528,
"last_updated_by": "REQUESTER",
"last_customer_replied_time": 1489653242528,
"first_notes_text": "Hello I am testing your docs and find that Test is not working. Please help me",
"last_reply_text": "Hello I am testing your docs and find that Test is not working. Please help me",
"is_compressed": false,
"status": "OPEN",
"type": "PROBLEM",
"priority": "LOW",
"source": "EMAIL",
"created_by": "CUSTOMER",
"user_replies_count": 1,
"no_of_reopens": 0,
"attachments_exists": false,
"is_favorite": false,
"is_spam": false,
"requester_ip_address": "",
"html_text": "",
"entity_type": "tickets",
"attachments_list": [],
"labels": [],
"contact_ids": [],
"last_ticket_notes": {
"id": 6005534641618944,
"plain_text": "Hello I am testing your docs and find that Test is not working. Please help me",
"created_time": 1489653122960,
"ticket_notes_assinee": {
"id": 6263975862861824,
"domain": "dsd",
"email": "[email protected]",
"phone": "",
"name": "dsdsd",
"pic": "https://d1gwclp1pmzk26.cloudfront.net/img/gravatar/71.png",
"schedule_id": "Ghanshyam",
"calendar_url": "https://ghanshyam.agilecrm.com/calendar/dsd",
"calendarURL": "https://ghanshyam.agilecrm.com/calendar/dsd"
}
},
"contact": {
"id": 5723745293434880,
"type": "PERSON",
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "dsd"
},
{
"type": "SYSTEM",
"name": "last_name",
"value": ""
},
{
"type": "SYSTEM",
"name": "name",
"value": ""
}
]
}
},
{
"id": 3,
"groupID": 5756098678095872,
"group": {
"id": 5756098678095872,
"group_name": "Support",
"group_email": "[email protected]"
},
"assigned_to_group": true,
"assigneeID": 6263975862861824,
"assigned_time": 1489649282800,
"assignee": {
"id": 6263975862861824,
"domain": "sdsd",
"email": "[email protected]",
"phone": "",
"name": "sdsds",
"pic": "https://d1gwclp1pmzk26.cloudfront.net/img/gravatar/71.png",
"schedule_id": "Ghanshyam",
"calendar_url": "https://ghanshyam.agilecrm.com/calendar/Ghanshyam",
"calendarURL": "https://ghanshyam.agilecrm.com/calendar/Ghanshyam"
},
"requester_name": "sdsd ",
"requester_email": "[email protected]",
"contactID": 5723745293434880,
"subject": "Test not working ??",
"cc_emails": [
"[email protected]"
],
"created_time": 1489649282800,
"last_updated_time": 1489649282800,
"last_updated_by": "REQUESTER",
"last_customer_replied_time": 1489649282800,
"first_notes_text": "Hello I am testing your docs and find that Test is not working. Please help me",
"last_reply_text": "Hello I am testing your docs and find that Test is not working. Please help me",
"is_compressed": false,
"status": "OPEN",
"type": "PROBLEM",
"priority": "LOW",
"source": "EMAIL",
"created_by": "CUSTOMER",
"user_replies_count": 1,
"no_of_reopens": 0,
"attachments_exists": false,
"is_favorite": false,
"is_spam": false,
"requester_ip_address": "",
"html_text": "",
"entity_type": "tickets",
"attachments_list": [],
"labels": [],
"contact_ids": [],
"last_ticket_notes": {
"id": 5766442402185216,
"plain_text": "Hello I am testing your docs and find that Test is not working. Please help me",
"created_time": 1489649163240,
"ticket_notes_assinee": {
"id": 6263975862861824,
"domain": "sdsd",
"email": "[email protected]",
"phone": "",
"name": "dssds",
"pic": "https://d1gwclp1pmzk26.cloudfront.net/img/gravatar/71.png",
"schedule_id": "samplet",
"calendar_url": "https://ghanshyam.agilecrm.com/calendar/Ghanshyam",
"calendarURL": "https://ghanshyam.agilecrm.com/calendar/Ghanshyam"
}
},
"contact": {
"id": 5723745293434880,
"type": "PERSON",
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "sdsd"
},
{
"type": "SYSTEM",
"name": "last_name",
"value": ""
},
{
"type": "SYSTEM",
"name": "name",
"value": ""
}
]
}
},
{
"id": 2,
"groupID": 5756098678095872,
"group": {
"id": 5756098678095872,
"group_name": "Support",
"group_email": "[email protected]"
},
"assigned_to_group": true,
"assigneeID": 6263975862861824,
"assigned_time": 1489648321029,
"assignee": {
"id": 6263975862861824,
"domain": "samplet",
"email": "[email protected]",
"phone": "",
"name": "Ghanshyam",
"pic": "https://d1gwclp1pmzk26.cloudfront.net/img/gravatar/71.png",
"schedule_id": "sdsd",
"calendar_url": "https://ghanshyam.agilecrm.com/calendar/Ghanshyam",
"calendarURL": "https://ghanshyam.agilecrm.com/calendar/Ghanshyam"
},
"requester_name": "sdsds ",
"requester_email": "[email protected]",
"contactID": 5723745293434880,
"subject": "Test not working ??",
"cc_emails": [
"[email protected]"
],
"created_time": 1489648321029,
"last_updated_time": 1489648321029,
"last_updated_by": "REQUESTER",
"last_customer_replied_time": 1489648321029,
"first_notes_text": "Hello I am testing your docs and find that Test is not working. Please help me",
"last_reply_text": "Hello I am testing your docs and find that Test is not working. Please help me",
"is_compressed": false,
"status": "OPEN",
"type": "PROBLEM",
"priority": "LOW",
"source": "EMAIL",
"created_by": "CUSTOMER",
"user_replies_count": 1,
"no_of_reopens": 0,
"attachments_exists": false,
"is_favorite": false,
"is_spam": false,
"requester_ip_address": "",
"html_text": "",
"entity_type": "tickets",
"attachments_list": [],
"labels": [],
"contact_ids": [],
"last_ticket_notes": {
"id": 5386771856621568,
"plain_text": "Hello I am testing your docs and find that Test is not working. Please help me",
"created_time": 1489648201476,
"ticket_notes_assinee": {
"id": 6263975862861824,
"domain": "sdsd",
"email": "[email protected]",
"phone": "",
"name": "sdsdsd",
"pic": "https://d1gwclp1pmzk26.cloudfront.net/img/gravatar/71.png",
"schedule_id": "Ghanshyam",
"calendar_url": "https://ghanshyam.agilecrm.com/calendar/Ghanshyam",
"calendarURL": "https://ghanshyam.agilecrm.com/calendar/Ghanshyam"
}
},
"contact": {
"id": 5723745293434880,
"type": "PERSON",
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "sdsdsd"
},
{
"type": "SYSTEM",
"name": "last_name",
"value": ""
},
{
"type": "SYSTEM",
"name": "name",
"value": ""
}
]
}
},
{
"id": 1,
"groupID": 5756098678095872,
"group": {
"id": 5756098678095872,
"group_name": "Support",
"group_email": "[email protected]"
},
"assigned_to_group": false,
"assigneeID": 6263975862861824,
"assigned_time": 1489647974608,
"assignee": {
"id": 6263975862861824,
"domain": "sdsd",
"email": "[email protected]",
"phone": "",
"name": "sds",
"pic": "https://d1gwclp1pmzk26.cloudfront.net/img/gravatar/71.png",
"schedule_id": "sdsd",
"calendar_url": "https://ghanshyam.agilecrm.com/calendar/Ghanshyam",
"calendarURL": "https://ghanshyam.agilecrm.com/calendar/Ghanshyam"
},
"requester_name": "sdds ",
"requester_email": "[email protected]",
"contactID": 5723745293434880,
"subject": "Help Desk Ticket",
"cc_emails": [
"[email protected]"
],
"created_time": 1489647899863,
"last_updated_time": 1489647974419,
"last_updated_by": "AGENT",
"first_replied_time": 1489647974608,
"last_agent_replied_time": 1489647974419,
"last_customer_replied_time": 1489647899863,
"first_notes_text": "Hello test body of message",
"last_reply_text": "We will check and let you know\r\n\r\nThanks<br />Ghanshyam Raut",
"is_compressed": false,
"status": "PENDING",
"type": "PROBLEM",
"priority": "MEDIUM",
"source": "EMAIL",
"created_by": "CUSTOMER",
"user_replies_count": 2,
"no_of_reopens": 0,
"attachments_exists": false,
"is_favorite": false,
"is_spam": false,
"requester_ip_address": "",
"html_text": "",
"entity_type": "tickets",
"attachments_list": [],
"labels": [],
"contact_ids": [],
"last_ticket_notes": {
"id": 5447141916934144,
"plain_text": "We will check and let you know\r\n\r\nThanks<br />Ghanshyam Raut",
"created_time": 1489647914834,
"ticket_notes_assinee": {
"id": 6263975862861824,
"domain": "sdsd",
"email": "[email protected]",
"phone": "",
"name": "sdsds",
"pic": "https://d1gwclp1pmzk26.cloudfront.net/img/gravatar/71.png",
"schedule_id": "Ghanshyam",
"calendar_url": "https://ghanshyam.agilecrm.com/calendar/Ghanshyam",
"calendarURL": "https://ghanshyam.agilecrm.com/calendar/Ghanshyam"
}
},
"contact": {
"id": 5723745293434880,
"type": "PERSON",
"properties": [
{
"type": "SYSTEM",
"name": "first_name",
"value": "ds"
},
{
"type": "SYSTEM",
"name": "last_name",
"value": ""
},
{
"type": "SYSTEM",
"name": "name",
"value": ""
}
]
}
}
]Method: POST
- Creates a new ticket.
- All fields are mandatory.
{
"requester_name": "yeki",
"requester_email": "[email protected]",
"subject": "Test not working ??",
"priority": "LOW",
"status": "OPEN",
"groupID": "5756098678095872",
"html_text": "Hello I am testing your docs and find that Test is not working. Please help me",
"cc_emails": [
"[email protected]"
],
"labels": null
}curl https://{domain}.agilecrm.com/dev/api/tickets/new-ticket \
-H "Accept : application/json" \
-H "Content-Type: application/json" \
-d '{
"requester_name": "yeki",
"requester_email": "[email protected]",
"subject": "Test not working ??",
"priority": "LOW",
"status": "OPEN",
"groupID": "5756098678095872",
"html_text": "Hello I am testing your docs and find that Test is not working. Please help me",
"cc_emails": [
"[email protected]"
],
"labels": null
}' \
-v -u [email protected]:123456 -X POST- Status 200: Ticket added successfully and it returns the newly created ticket as JSON in response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
Method: DELETE
- It deletes the ticket having a particular id. The id passed in the url will be used to identify the ticket.
curl https:{domain}.agilecrm.com/dev/api/tickets/100 -H "Accept:application/json" -v -u {email}:{API Key} -X DELETE- Status 200: {"status":"success"}
- Status 401: Unauthorized (When the username and password provided in the respective fields are incorrect)
Method: GET
- Returns list of filter IDs in JSON format.
curl https://{domain}.agilecrm.com/dev/api/tickets/filters -H "Accept : application/json" -v -u {email} : {API Key}[
{
"id": 5632682255974400,
"name": "All Tickets",
"conditions": [
{
"LHS": "status",
"CONDITION": "TICKET_STATUS_IS",
"RHS": "NEW"
},
{
"LHS": "status",
"CONDITION": "TICKET_STATUS_IS",
"RHS": "OPEN"
},
{
"LHS": "status",
"CONDITION": "TICKET_STATUS_IS",
"RHS": "PENDING"
},
{
"LHS": "status",
"CONDITION": "TICKET_STATUS_IS",
"RHS": "CLOSED"
}
],
"owner_id": 6263975862861824,
"updated_time": 1461208420071,
"is_default_filter": true
},
{
"id": 5644924254945280,
"name": "New Tickets",
"conditions": [
{
"LHS": "status",
"CONDITION": "TICKET_STATUS_IS",
"RHS": "NEW"
}
],
"owner_id": 6263975862861824,
"updated_time": 1461208419652,
"is_default_filter": true
},
{
"id": 5716987632156672,
"name": "My Tickets",
"conditions": [
{
"LHS": "assignee_id",
"CONDITION": "EQUALS",
"RHS": "0"
}
],
"owner_id": 6263975862861824,
"updated_time": 1461208420470,
"is_default_filter": true
}
]
Method: GET
- Returns list of JSON tickets.
https://{domain}.agilecrm.com/dev/api/tickets/notes/{ticketid} -H "Accept : application/json" -v -u {email} : {API Key}[
{
"id": 5661725076488192,
"ticket_id": 2,
"group_id": 5646239437684736,
"feedback_time": 1496990444098,
"feedback_comment": "",
"assignee_id": 6683813135253504,
"feedback_flag": false,
"created_by": "REQUESTER",
"requester_name": "Prabathk kolipaka",
"requester_email": "[email protected]",
"created_time": 1496990444098,
"event_description": "",
"plain_text": "Get all the messages belongs to a ticket",
"html_text": "Get all the messages belongs to a ticket",
"mime_object": "",
"note_type": "PUBLIC",
"attachments_list": [
],
"requester_viewed_time": 0,
"domain_user": {
"id": 6683813135253504,
"domain": "ranjandev",
"email": "[email protected]",
"phone": "",
"name": "Rasmi Ranjan Swain",
"pic": "https://d1gwclp1pmzk26.cloudfront.net/img/gravatar/48.png",
"schedule_id": "Rasmi_Ranjan_Swain",
"calendar_url": "https://ranjandev.agilecrm.com/calendar/Rasmi_Ranjan_Swain",
"calendarURL": "https://ranjandev.agilecrm.com/calendar/Rasmi_Ranjan_Swain"
},
"cc_emails": [
],
"close_ticket": false,
"requester_viewed_email": false,
"is_compressed": false
}
]- Status 200: Successfully retrieved all the messages within a ticket.
- Status 401: Unauthorised. (When the user name and password fields are wrong.)
Method: POST
- Creates a note to specific ticket.
curl https://{domain}.agilecrm.com/dev/api/notes/{ticket-id} \
-H "Content-Type : application/json" \
-H "Accept : application/json" \
-d '{
"ticket_id":"{ticket-id}",
"html_text":"Note description",
"note_type":"PUBLIC"
}' \
-v -u {email} : {APi Key} -X POST- Adding Notes to A particular group ticket.
curl https://{domain}.agilecrm.com/dev/api/notes/{ticket-id} \
-H "Content-Type : application/json" \
-H "Accept : application/json" \
-d '{
"ticket_id":"{ticket-id}",
"html_text":"Note description",
"note_type":"PRIVATE"
}' \
-v -u {email} : {APi Key} -X POST- Status 200: Note added successfully and it returns the ticket as JSON in response.
- Status 401: Unauthorised. (when the user name and password fields are wrong.)
- Status 400: If the input is in wrong format
Method: POST
- Returns contacts or companies objects which is associated with given filter
curl https://{your_domain}.agilecrm.com/dev/api/filters/filter/dynamic-filter -H "Accept: application/json" \
-H "Content-Type :application/x-www-form-urlencoded" \
-d 'page_size=25&global_sort_key=-created_time&filterJson={"rules":[{"LHS":"updated_time","CONDITION":"LAST","RHS":"1"}],"or_rules":[],"contact_type":"PERSON"}' \
-v -u [email protected]:123fghfhf******* -X POSTMethod: POST
- Returns contacts or companies objects which is associated with given filter
curl https://{your_domain}.agilecrm.com/dev/api/filters/filter/dynamic-filter -H "Accept: application/json" \
-H "Content-Type :application/x-www-form-urlencoded" \
-d 'page_size=25&global_sort_key=-created_time&filterJson={"rules":[{"LHS":"updated_time","CONDITION":"AFTER","RHS":1572580800000}],"or_rules":[],"contact_type":"PERSON"}' \
-v -u [email protected]:123fghfhf******* -X POSTMethod: POST
- Returns contacts or companies objects which is associated with given filter
curl https://{your_domain}.agilecrm.com/dev/api/filters/filter/dynamic-filter -H "Accept: application/json" \
-H "Content-Type :application/x-www-form-urlencoded" \
-d 'page_size=25&global_sort_key=-created_time&filterJson={"rules":[{"LHS":"tags","CONDITION":"EQUALS","RHS":"paid"},{"LHS":"updated_time","CONDITION":"ON","RHS":1572580800000}],"or_rules":[],"contact_type":"PERSON"}' \
-v -u [email protected]:123fghfhf******* -X POSTMethod: POST
- Returns contacts or companies objects which is associated with given filter
curl https://{your_domain}.agilecrm.com/dev/api/filters/filter/dynamic-filter -H "Accept: application/json" \
-H "Content-Type :application/x-www-form-urlencoded" \
-d 'page_size=10&global_sort_key=-updated_time&filterJson={"rules":[],"or_rules":[{"LHS":"tags","CONDITION":"EQUALS","RHS":"VIP"},{"LHS":"tags","CONDITION":"EQUALS","RHS":"paid"}],"contact_type":"PERSON"}' \
-v -u [email protected]:123fghfhf******* -X POSTMethod: POST
- Returns contacts or companies objects which is associated with given filter
curl https://{your_domain}.agilecrm.com/dev/api/filters/filter/dynamic-filter -H "Accept: application/json" \
-H "Content-Type :application/x-www-form-urlencoded" \
-d 'page_size=25&global_sort_key=-created_time&filterJson={"rules":[],"or_rules":[{"LHS":"updated_time","CONDITION":"BETWEEN","RHS":1574053200000,"RHS_NEW":1574312399999}, {"LHS":"created_time","CONDITION":"BETWEEN","RHS":1574053200000,"RHS_NEW":1574312399999}],"contact_type":"PERSON"' \
-v -u [email protected]:123fghfhf******* -X POSTMethod: POST
- Returns deals objects which is associated with given filter
curl https://{your_domain}.agilecrm.com/dev/api/filters/filter/dynamic-filter -H "Accept: application/json" \
-H "Content-Type :application/x-www-form-urlencoded" \
-d 'page_size=25&filterJson={"rules":[{"LHS":"updated_time","CONDITION":"ON","RHS":1572580800000}],"or_rules":[],"contact_type":"OPPORTUNITY"}' \
-v -u [email protected]:123fghfhf******* -X POST
