Cases
Get all cases
GET /cases
Query string parameters
-
show
string- One of the following:
mine
team
- One of the following:
-
status
string- One of the following:
open
closed
declined
- One of the following:
sort_mode
string- One of the following:
important
(default; chronological, but show cases without activites/actions first)recent
(sort cases by status, then latest activity, finally update date)
- One of the following:
users
UUID - Returns cases the user with given ID is responsible forteams
UUID - Returns cases the team with given ID is responsible forcreated_from_lead
boolUndefined/Nothing Submitted
- Returns all cases, whether it was created from a lead or not
-
lead_types
UUID - Only returns tasks with one of these lead type ids (comma separated)- Cannot be used, if
created_from_lead
is set
- Cannot be used, if
-
relations_paths
UUID - Only show tasks with one of these relations path ids (comma separated) start_at
date - Only show cases created after this date- Y-m-d H:i:s format
end_at
date - Only show cases created before this date- Y-m-d H:i:s format
- Must be after
start_at
milestone_types
string - Only show cases with milestone type (comma separated)- Supports the following types:
test_drive
offer
need_analysis
- Supports the following types:
milestone_ids
UUID - Only show cases where highest ranking milestone match provided ids (comma separated)milestone_start_at
date - Only show cases with a milestone created after this date- Y-m-d H:i:s format
milestone_end_at
date - Only show cases with a milestone created before this date- Y-m-d H:i:s format
- Must be after
milestone_start_at
-
lead_sources
string - Only shows cases which were created based on a lead -
Supports Searching
- Supports Pagination
Response
Status code 200
Deprecated response
latest_milestone_name
deprecated in favor oflatest_activity
- Removal: 2018/04/01
lead_source
deprecated in favor oflead.lead_source
- Removal: 2020/07/01
escalates_at
deprecated in favor oflead.escalates_at
- Removal: 2020/07/01
{
"data": [
{
"id": "69faaea2-156d-4b57-89e5-25fd094ef406",
"case_number": 96,
"status": "open",
"account": {
"id": "551b99f4-5a83-05a4-4194-7e05fe920d2a",
"name": "Scelerisque Lorem Ltd"
},
"contact": {
"id": "e2ade531-5efc-e19b-1783-a69eb3f5c87b",
"name": "Gemma Chan"
},
"user": {
"id": 1,
"name": "John Doe"
},
"relations_paths": {
"id": "e2ade531-5efc-e19b-1783-a69eb3f5c87b"
},
"milestones": [
{
"id": "f647ef48-7c63-47ae-b2ea-3f15029668cb",
"name": "Some type",
"done": false
},
{
"id": "f647ef48-7c63-47ae-b2ea-3f15029668cb",
"name": "Some other type",
"done": false
},
{
"id": "4dc72ee0-eeeb-435d-9522-6bfafa66ed20",
"name": "Some third type",
"done": false
}
],
"latest_milestone_name": null,
"latest_activity_at": null,
"latest_activity": {
"type": "milestone",
"id": "f647ef48-7c63-47ae-b2ea-3f15029668cb",
"name": "Some type",
"created_at": "2017-07-31 09:14:42"
},
"next_task": {
"type": "meeting",
"start_at": "2015-02-03 12:00:00",
"end_at": "2015-02-03 13:30:00"
},
"next_pending_automated_communication": {
"send_at": "2015-02-04 12:00:00"
},
"lead": {
"id": "0598c7ba-8b89-4f5f-80d2-907acedf2a9f",
"lead_type_id": "990f3e13-d891-460e-82da-5af3a223b6b3",
"interest": "occaecati quia tempore",
"lead_source": "Jaeger und Schmitter",
"lead_data": null,
"escalates_at": "2019-12-07 21:00:00",
"created_at": "2019-11-30 07:48:10",
"updated_at": "2019-12-02 11:35:58"
},
"product_details": [
{
"id": "25ffbe76-0241-4922-b9fb-ff95ba754856",
"products": [
{
"id": "507677ff-eb63-3642-8fdf-f69478eef3b7",
"name": "accusantium",
"quantity": 1,
"type": null,
"price": 0,
"discount": 0,
"comment": null
}
],
"created_at": "2019-12-02 11:42:08",
"updated_at": "2019-12-02 11:42:08"
}
],
"lead_source": "lead-source",
"escalates_at": "2015-02-05 08:00:00",
"created_at": "2015-02-02 06:58:42",
"updated_at": "2015-02-02 06:58:42"
}
],
"pagination": {
"total": 101,
"page": 1,
"per_page": 15,
"urls": {
"previous": null,
"next": "http://api.easir.com/cases/?page=2"
}
},
"statuses": {
"all": 101,
"open": 45,
"closed": 32,
"declined": 24
}
}
Create a case
POST /cases
Parameters
user_id
integer- Must be a user id that belongs to your company.
- Required
team_id
integer- User must be a part of this team.
contact_id
UUID- Must be a UUID, that belongs to one of your accounts.
- Required
relations_path_id
UUID- Must be a UUID, that belongs to your company.
- Required
notify_user
boolean - If the creating user and responsible user differ, should the user be notified?- default:
false
- default:
Payload
{
"user_id" : 1,
"contact_id" : "e2ade531-5efc-e19b-1783-a69eb3f5c87b",
"relations_path_id" : "551b99f4-5a83-05a4-4194-7e05fe920d2a"
}
Response
Status code 201
Deprecated response
latest_milestone_name
deprecated in favor oflatest_activity
- Removal: 2018/04/01
{
"id": "47753095-0eb0-4965-8512-19003a3b96ee",
"case_number": 97,
"status": "open",
"account": {
"id": "551b99f4-5a83-05a4-4194-7e05fe920d2a",
"name": "Scelerisque Lorem Ltd"
},
"contact": {
"id": "e2ade531-5efc-e19b-1783-a69eb3f5c87b",
"name": "Gemma Chan"
},
"user": {
"id": 1,
"name": "John Doe"
},
"relations_path": {
"id": 1
},
"milestones": [],
"latest_milestone_name": null,
"latest_activity_at": null,
"latest_activity": null,
"created_at": "2015-02-02 07:53:57",
"updated_at": "2015-02-02 07:53:57"
}
Update a case
PUT /cases/:case_id
Parameters
user_id
integer- Must be a user id that belongs to your company.
- Required
team_id
integer- User must be a part of this team.
contact_id
UUID- Must be a contact id that belongs to one of your accounts.
- Required
notify_user
boolean - If the creating user and responsible user differ, should the user be notified?- default:
false
- default:
Payload
{
"user_id": 4,
"contact_id": "e2ade531-5efc-e19b-1783-a69eb3f5c87b"
}
Response
Status code 200
Deprecated response
latest_milestone_name
deprecated in favor oflatest_activity
- Removal: 2018/04/01
{
"id": "47753095-0eb0-4965-8512-19003a3b96ee",
"case_number": 97,
"status": "open",
"account": {
"id": "551b99f4-5a83-05a4-4194-7e05fe920d2a",
"name": "Scelerisque Lorem Ltd"
},
"contact": {
"id": "e2ade531-5efc-e19b-1783-a69eb3f5c87b",
"name": "Gemma Chan"
},
"user": {
"id": 4,
"name": "Jane Doe"
},
"relations_path": {
"id": 1
},
"milestones": [],
"latest_milestone_name": null,
"latest_activity_at": null,
"latest_activity": null,
"created_at": "2015-02-02 07:53:57",
"updated_at": "2015-02-02 07:55:20"
}
Decline a case (Beta)
PUT /cases/:case_id/decline
Parameters
reason
string- Required
Payload
{
"reason": "reason for declining the case"
}
Response
Status code 200
Response is the same as Find a case, but the status changed:
{
"status": "declined"
}
Note * This is used to decline a case without creating an activity.
Find a case
GET /cases/:case_id
Response
Status code 200
Deprecated response fields
latest_milestone_name
deprecated in favor oflatest_activity
- Removal: 2018/04/01
relations_path.is_sales_type
- Removal: 2019/11/01
lead_source
deprecated in favor oflead.lead_source
- Removal: 2020/07/01
escalates_at
deprecated in favor oflead.escalates_at
- Removal: 2020/07/01
{
"id": "47753095-0eb0-4965-8512-19003a3b96ee",
"case_number": 97,
"status": "open",
"account": {
"id": "dd2ec999-1fc9-3700-97cb-093846824586",
"b2c": false,
"user": {
"id": 22,
"first_name": "Levi",
"last_name": "Stark",
"phone_number": "635.725.7421",
"job_title": "Data Analytics Engineer",
"email": "20@example.com",
"email_notifications": false,
"profile_picture": null,
"system_user": false,
"created_at": "2017-05-28 02:57:26",
"updated_at": "2017-09-04 03:01:25"
}
},
"team_id": 1,
"team": {
"id": 1,
"name": "Team 1",
"address_1": "Savannah 123",
"address_2": "Under the tree on the left",
"zip_code": "4730",
"city": "Umzimkulu",
"state": "KwaZulu-Natal",
"country": null,
"phone_number": "031 308 7900",
"website": "https://easir.com",
"vat": "1234567890123456",
"team_type": null,
"group_id": 1,
"use_social_lookup": false,
"created_at": "2014-01-01 12:45:56",
"updated_at": "2014-01-02 00:11:22"
},
"contact": {
"id": "705d10b2-44e4-3e41-b1c3-879592045eef",
"b2c": false,
"account": {
"id": "dd2ec999-1fc9-3700-97cb-093846824586",
"name": "Bentzen ApS"
},
"user": {
"id": 28,
"first_name": "Vivian",
"last_name": "Murray",
"phone_number": "+1-228-753-7737",
"job_title": "Downstream Processing Scientist",
"email": "26@example.com",
"email_notifications": false,
"profile_picture": null,
"system_user": false,
"created_at": "2017-03-29 16:02:07",
"updated_at": "2017-04-22 18:50:41"
},
"team_id": 1,
"team": {
"id": 1,
"name": "Team 1",
"address_1": "Savannah 123",
"address_2": "Under the tree on the left",
"zip_code": "4730",
"city": "Umzimkulu",
"state": "KwaZulu-Natal",
"country": null,
"phone_number": "031 308 7900",
"website": "https://easir.com",
"vat": "1234567890123456",
"team_type": null,
"group_id": 1,
"use_social_lookup": false,
"created_at": "2014-01-01 12:45:56",
"updated_at": "2014-01-02 00:11:22"
},
"status": "customer"
},
"user": {
"id": 26,
"first_name": "Mariane",
"last_name": "McGlynn",
"phone_number": "975-496-7150 x037",
"job_title": "Data Analyst",
"email": "24@example.com",
"email_notifications": false,
"profile_picture": null,
"system_user": false,
"created_at": "2017-04-21 22:55:20",
"updated_at": "2017-05-26 04:07:02"
},
"recent_activity": {
"id": "8e684f42-15d2-4e7e-b354-d660cc5d632c",
"activity_types": [
{
"id": "97b7a8d1-d3b1-4358-80c5-2652a72c49fd",
"name": "Untitled",
"description": null,
"is_milestone": true
}
],
"communication_channel": "none",
"extra_steps": [],
"note": {
"id": 1624883,
"note": "Here is some note",
"case_id": "95112ce6-f9bd-4f4d-8261-5498475bc5fe",
"activity_id": "8e684f42-15d2-4e7e-b354-d660cc5d632c",
"contact_id": "a4ec43a5-df30-4d6e-a853-6b0fa35e1739",
"account_id": "2f83ad9b-6528-4d68-83de-89abab9a80bb",
"updated": false,
"case": null,
"team_id": 1,
"created_at": "2020-09-18 12:30:59",
"updated_at": "2020-09-18 12:30:59"
},
"correspondence": {
"email": null,
"letter": null
},
"product_detail": null,
"product_details": null,
"task": null,
"completed_task_id": null,
"user": {
"id": 2,
"first_name": "Herman",
"last_name": "Rempelddd",
"phone_number": "+4542704443",
"job_title": null,
"email": "24@example.com",
"email_notifications": false,
"profile_picture": "http://look-alikes.dk/resized/648efcc8df39e085661c2f528dce7447.jpg",
"system_user": false,
"created_at": "2015-05-09 12:57:58",
"updated_at": "2020-09-18 12:28:26"
},
"created_at": "2020-09-18 12:30:59",
"updated_at": "2020-09-18 12:30:59"
},
"relations_path": {
"id": "1eae431b-3d0f-4528-9c59-e9d1a40fcd04",
"name": "TEST RELATIONS PATH",
"is_sales_type": true
},
"chance_of_success": 23,
"milestones": [
{
"id": "25f991e6-5d32-4f09-89ec-4887afa18142",
"name": "Some type",
"done": false
},
{
"id": "5867a0d7-c744-400c-a2b4-486a0f92d055",
"name": "Some other type",
"done": false
},
{
"id": "8aa2ac54-7008-4413-a567-9fe0ae0c26b5",
"name": "Some fourth type",
"done": false
}
],
"latest_milestone_name": null,
"latest_activity_at": null,
"latest_activity": null,
"created_at": "2015-02-02 07:53:57",
"updated_at": "2015-02-02 07:55:20",
"estimated_close_date": "2015-02-24",
"activity_count": 0,
"lead_source": "lead-source",
"escalates_at": null,
"product_details": null,
"tasks": null,
"attachments": null,
"lead": null
}
Delete a case
Admins and team admins can delete cases.
DELETE /cases/:case_id
Response Status code 204
Update chance of success
PUT /cases/:case_id/chance_of_success
Parameters
chance_of_success
integer- Between 0 and 100.
- Required
Payload
{
"chance_of_success": 75
}
Response
Status code 200
{
"id": "65a3b976-2abb-6d02-499b-933f1e641546",
"case_number": 231,
"status": "open",
"account": {
"id": "0de95f95-a5b9-2960-1d21-5d7cccfa45ad",
"name": "Praesent Consulting"
},
"contact": {
"id": "024217da-f2b3-4854-a24f-04418f560725",
"name": "John Johnson Doe"
},
"user": {
"id": 1,
"name": "John Doe"
},
"relations_path": {
"id": 1
},
"chance_of_success": 75,
"milestones": [],
"latest_milestone_name": null,
"latest_activity_at": "2015-02-03 10:10:40",
"latest_activity": null,
"estimated_close_date": "2015-03-15",
"created_at": "2015-02-03 10:10:40",
"updated_at": "2015-02-03 10:10:40"
}
Update estimated close date
PUT /cases/:case_id/estimated_close_date
Parameters
date
date- Y-m-d format.
- Required
Payload
{
"date": "2015-03-15"
}
Response
Status code 200
Deprecated response
latest_milestone_name
deprecated in favor oflatest_activity
- Removal: 2018/04/01
{
"id": "65a3b976-2abb-6d02-499b-933f1e641546",
"case_number": 231,
"status": "open",
"account": {
"id": "0de95f95-a5b9-2960-1d21-5d7cccfa45ad",
"name": "Praesent Consulting"
},
"contact": {
"id": "024217da-f2b3-4854-a24f-04418f560725",
"name": "John Johnson Doe"
},
"user": {
"id": 1,
"name": "John Doe"
},
"relations_path": {
"id": 1
},
"chance_of_success": 75,
"milestones": [],
"latest_milestone_name": null,
"latest_activity_at": "2015-02-03 10:10:40",
"latest_activity": null,
"estimated_close_date": "2015-03-15",
"created_at": "2015-02-03 10:10:40",
"updated_at": "2015-02-03 10:10:40"
}
Update case files
Add files from the file manager as attachments to the specified case.
PUT /cases/:case_id/attachments
Parameters
files
arrayfiles.*
UUID
Payload
{
"files": [
"fad9e028-6223-4165-b103-38199eddb069"
]
}
Response
Status code 200
Deprecated response
latest_milestone_name
deprecated in favor oflatest_activity
- Removal: 2018/04/01
{
"id": "da79fcb1-4fc3-3250-9206-e38eff52bf1b",
"case_number": 2,
"status": "open",
"account": {
"id": "3cb87c2f-0feb-3b10-90a1-b5d01bb3eb69",
"name": "B2C - Krogh & Vester"
},
"contact": {
"id": "8dbb05f9-e19c-34f8-8885-eed4e520bf3c",
"name": "Inge-Lise Rosenberg"
},
"user": {
"id": 24,
"name": "Phyllis Halvorson"
},
"relations_path": {
"id": "9eae431b-3d0f-4528-9c59-e9d1a40fcd04",
"name": "Case type"
},
"attachments": [
{
"id": "fad9e028-6223-4165-b103-38199eddb069",
"name": "attachment_test_pdf.pdf",
"type": "pdf",
"size": 9968,
"created_at": "2015-07-10 13:14:48",
"updated_at": "2015-07-10 13:14:48",
"company_id": 1,
"belongs_to": "user",
"folder_id": null,
"user_id": 1
}
],
"chance_of_success": 21,
"milestones": [
{
"id": "a203539b-f06c-442c-8ad0-f5a56f0615f6",
"name": "Contract",
"done": false
},
{
"id": "943cef92-f9b4-4fcb-b4e4-834f34915973",
"name": "Milestone 2",
"done": true
}
],
"latest_milestone_name": null,
"latest_activity_at": "2015-06-07 12:41:40",
"latest_activity": {
"type": "milestone",
"id": "943cef92-f9b4-4fcb-b4e4-834f34915973",
"name": "Milestone 2",
"created_at": "2017-07-31 09:14:42"
},
"estimated_close_date": "2016-01-13",
"created_at": "2015-02-24 12:34:56",
"updated_at": "2015-02-24 12:34:56"
}
Get top-closing-users
Get a list of the 5 users who have closed the most cases in the last month
GET /cases/leaderboard
Response
Status code 200
{
"data": [
{
"count": 28,
"user": {
"id": 16,
"first_name": "Tyrique",
"last_name": "Purdy",
"phone_number": "1-275-495-8397",
"job_title": "Data Scientist, Analytics",
"email": "14@example.com",
"profile_picture": null,
"created_at": "2014-12-11 11:37:38",
"updated_at": "2015-01-22 02:19:10"
}
}
]
}
Get timeline
GET /cases/:case_id/timeline
Query string parameters
- Supports Pagination
activity_types
UUID - Only show events with one of these activity type ids (comma separated)start_at
date - Only show events created after this date- Y-m-d H:i:s format
end_at
date - Only show events created before this date- Y-m-d H:i:s format
- Must be after
start_at
types
string - Only show events from one of these groups (comma separated)campaign
case
consent
external
Response
Status code 200
Deprecated response
latest_milestone_name
deprecated in favor oflatest_activity
- Removal: 2018/04/01
{
"data": [
{
"id": "f6c7bb4a-1cdb-4a24-b704-b480fc976f3b",
"type": "external",
"user": {
"id": 1,
"first_name": "Jane",
"last_name": "Doe",
"phone_number": "+4588888888",
"job_title": "Sales Executive",
"email": "demo@easir.com",
"email_notifications": false,
"profile_picture": "https://randomuser.me/api/portraits/thumb/women/5.jpg",
"created_at": "2014-01-01 12:45:56",
"updated_at": "2014-01-02 00:11:22"
},
"data": {
"user": {
"id": 1,
"first_name": "Jane",
"last_name": "Doe",
"phone_number": "+4588888888",
"job_title": "Sales Executive",
"email": "demo@easir.com",
"email_notifications": false,
"profile_picture": "https://randomuser.me/api/portraits/thumb/women/5.jpg",
"created_at": "2014-01-01 12:45:56",
"updated_at": "2014-01-02 00:11:22"
},
"account": {
"id": "77580fff-d847-3edc-90e7-f874ea19d776",
"b2c": false,
"user": {
"id": 12,
"first_name": "Oren",
"last_name": "Kreiger",
"phone_number": "+42(4)1455298851",
"job_title": "Data Scientist, Big Data Advanced Analytics",
"email": "settings@example.com",
"email_notifications": false,
"profile_picture": null,
"created_at": "2016-08-17 06:21:37",
"updated_at": "2016-08-20 02:14:53"
},
"team_id": 1,
"team": {
"id": 1,
"name": "UPDATED",
"address_1": null,
"address_2": null,
"zip_code": null,
"city": null,
"state": null,
"country": null,
"phone_number": null,
"website": null,
"vat": null,
"team_type": null,
"group_id": 1,
"use_social_lookup": false,
"created_at": "2014-01-01 12:45:56",
"updated_at": "2016-08-23 08:47:17"
},
"fixed_fields": [
{
"id": 1,
"type": "text",
"name": "name",
"label": "Name",
"value": "Kirk A/S",
"validation": null,
"required": true,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 2,
"type": "text",
"name": "address",
"label": "Address",
"value": "Kraghshaven 997, 7.\n5815 Assels",
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 3,
"type": "text",
"name": "zip_code",
"label": "Zip code",
"value": 9818,
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 4,
"type": "text",
"name": "city",
"label": "City",
"value": "Them",
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 5,
"type": "text",
"name": "state_region",
"label": "State/Region",
"value": "Høje Taastrup",
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 6,
"type": "single_choice",
"name": "country",
"label": "Country",
"value": {
"id": 136,
"value": "ES"
},
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 7,
"type": "text",
"name": "vat",
"label": "VAT",
"value": 21844056951,
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 8,
"type": "text",
"name": "website",
"label": "Website",
"value": "http://easir.com/ducimus-eaque-eius-quidem-sapiente-sunt.html",
"validation": "url",
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
}
],
"custom_fields": [
{
"id": 1,
"type": "text",
"name": "email",
"label": "Custom E-mail",
"value": null,
"validation": "email",
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 2,
"type": "numeric",
"name": "number",
"label": "Custom Number",
"value": null,
"validation": "numeric",
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 3,
"type": "date",
"name": "date",
"label": "Custom Date",
"value": null,
"validation": "date",
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 4,
"type": "boolean",
"name": "boolean",
"label": "Custom Boolean",
"value": null,
"validation": "boolean",
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 5,
"type": "single_choice",
"name": "single_choice",
"label": "Custom Single Choice",
"value": null,
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 6,
"type": "multiple_choice",
"name": "multiple_choice",
"label": "Custom Multiple Choice",
"value": null,
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
}
],
"created_at": "2015-02-24 12:34:56",
"updated_at": "2015-02-24 12:34:56",
"latest_milestone_name": null,
"latest_activity_at": null
},
"contact": {
"id": "4822677e-52f3-3abb-94ad-5a1c84dbdeaa",
"b2c": false,
"account": {
"id": "77580fff-d847-3edc-90e7-f874ea19d776",
"name": "Kirk A/S"
},
"user": {
"id": 10,
"first_name": "Ethel",
"last_name": "Ledner",
"phone_number": "1-560-112-1308x74487",
"job_title": "Data Modeler",
"email": "products@example.com",
"email_notifications": false,
"profile_picture": null,
"created_at": "2015-12-22 11:12:00",
"updated_at": "2016-01-17 00:23:51"
},
"team_id": 1,
"team": {
"id": 1,
"name": "UPDATED",
"address_1": null,
"address_2": null,
"zip_code": null,
"city": null,
"state": null,
"country": null,
"phone_number": null,
"website": null,
"vat": null,
"team_type": null,
"group_id": 1,
"use_social_lookup": false,
"created_at": "2014-01-01 12:45:56",
"updated_at": "2016-08-23 08:47:17"
},
"status": "customer",
"fixed_fields": [
{
"id": 10,
"type": "text",
"name": "salutation",
"label": "Salutation",
"value": "Dr.",
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 11,
"type": "text",
"name": "first_name",
"label": "First name",
"value": "Helge",
"validation": null,
"required": true,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 12,
"type": "text",
"name": "last_name",
"label": "Last name",
"value": "Clausen",
"validation": null,
"required": true,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 13,
"type": "text",
"name": "email",
"label": "Email",
"value": "Karlsen.Rebekka@easir.com",
"validation": "email",
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 14,
"type": "text",
"name": "landline_phone_number",
"label": "Landline phone number",
"value": "+45 80 66 21 03",
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 35,
"type": "text",
"name": "mobile_phone_number",
"label": "Mobile phone number",
"value": "+45 80 66 21 03",
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 16,
"type": "text",
"name": "title",
"label": "Title",
"value": "Teacher",
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
}
],
"custom_fields": [
{
"id": 8,
"type": "text",
"name": "email",
"label": "Custom E-mail",
"value": null,
"validation": "email",
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 9,
"type": "numeric",
"name": "number",
"label": "Custom Number",
"value": null,
"validation": "numeric",
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 10,
"type": "date",
"name": "date",
"label": "Custom Date",
"value": null,
"validation": "date",
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 11,
"type": "single_choice",
"name": "single_choice",
"label": "Custom Single Choice",
"value": null,
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 12,
"type": "multiple_choice",
"name": "multiple_choice",
"label": "Custom Multiple Choice",
"value": null,
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
}
],
"created_at": "2015-02-24 12:34:56",
"updated_at": "2015-02-24 12:34:56",
"latest_milestone_name": null,
"latest_activity_at": null,
"social_profile": {},
"consent": {
"call": {
"consent_given": null,
"updated_at": null
},
"letter": {
"consent_given": true,
"updated_at": "2017-02-25 12:34:56"
},
"email": {
"consent_given": false,
"updated_at": "2017-02-25 12:34:56"
}
}
},
"case": {
"id": "916a5d7c-543d-35c9-98f3-bed498aae485",
"number": 1469,
"relations_path_name": "TEST RELATIONS PATH"
},
"name": "this is an external activity"
},
"created_at": "2016-08-23 09:45:27",
"updated_at": "2016-08-23 09:45:27"
}
],
"pagination": {
"total": 1,
"page": 1,
"per_page": 15,
"urls": {
"previous": null,
"next": null
}
}
}
Create timeline entry
POST /cases/:case_id/timeline
You can create your own timeline entries. These entries will be of type external
.
Parameters
title
string- Max 255
description
string- Required
- Max 255
created_at
date- Y-m-d H:i:s format.
- Must be before "now".
files
arrayfiles.*
UUID
Deprecated parameters
name
string- Removal: 2018/04/01
Payload
{
"title": "Custom timeline entry title",
"description": "This is an external timeline entry",
"created_at": "2012-05-02 12:00:00",
"files": [
"0a84d647-0415-4824-ab19-da8d912111ab"
]
}
Response
Status code 204
Deprecated response
latest_milestone_name
deprecated in favor oflatest_activity
- Removal: 2018/04/01
Get additional data
GET /cases/:case_id/additional-data
Query string parameters
- Supports Pagination
Response
Status code 200
{
"data": [
{
"id": "57271551-ef3d-45e0-9f1a-c3c2e1a4dbc9",
"custom_fields": [
{
"id": 15,
"type": "text",
"name": "name",
"label": "name",
"value": null,
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
}
],
"created_at": "2018-02-19 13:20:29",
"updated_at": "2018-02-19 13:20:29",
"deprecated_at": null
}
],
"pagination": {
"total": 1,
"page": 1,
"per_page": 15,
"urls": {
"previous": null,
"next": null
}
}
}
Attach additional data to case
PUT /cases/:case_id/additional-data
You can attach additional data to non-sale type of case.
Parameters
additional-data
array- Required
additional-data.*
UUID
Payload
{
"additional-data" :[
"57271551-ef3d-45e0-9f1a-c3c2e1a4dbc9"
]
}
Response
Status code 200
{
"id": "57271551-ef3d-45e0-9f1a-c3c2e1a4dbc9",
"custom_fields": [
{
"id": 15,
"type": "text",
"name": "name",
"label": "name",
"value": null,
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
}
],
"created_at": "2018-02-19 13:20:29",
"updated_at": "2018-02-19 13:20:29",
"deprecated_at": null
}
Predict case for contact (Beta)
Selecting the most suitable case proposition for contact
GET /accounts/:account_id/contacts/:contact_id/cases/predicted
Response
Status code 204
When case can't be predicted
Response
Status code 200
Deprecated response fields
latest_milestone_name
deprecated in favor oflatest_activity
- Removal: 2018/04/01
relations_path.is_sales_type
- Removal: 2019/11/01
lead_source
deprecated in favor oflead.lead_source
- Removal: 2020/07/01
escalates_at
deprecated in favor oflead.escalates_at
- Removal: 2020/07/01
{
"id": "76177f5b-bff2-3ecc-b749-cfdac5fb2f7b",
"case_number": 22,
"status": "open",
"account": {
"id": "2f215f8b-b98d-3c62-b812-68c89dc26ff3",
"b2c": false,
"user": {
"id": 14,
"first_name": "Agustin",
"last_name": "Hettinger",
"phone_number": "(378) 277-9381 x796",
"job_title": "Director, Data Science",
"email": "12@example.com",
"email_notifications": false,
"profile_picture": null,
"system_user": false,
"created_at": "2018-07-27 22:31:10",
"updated_at": "2018-12-21 15:24:37"
},
"team_id": 1,
"team": {
"id": 1,
"name": "Team 1",
"address_1": "Savannah 123",
"address_2": "Under the tree on the left",
"zip_code": "4730",
"city": "Umzimkulu",
"state": "KwaZulu-Natal",
"country": null,
"phone_number": "031 308 7900",
"website": "https://easir.com",
"vat": "1234567890123456",
"team_type": null,
"group_id": 1,
"use_social_lookup": false,
"created_at": "2014-01-01 12:45:56",
"updated_at": "2014-01-02 00:11:22"
},
"fixed_fields": [
{
"id": 1,
"type": "text",
"name": "name",
"label": "Name",
"description": null,
"value": "Andreassen og Danielsen A/S",
"validation": null,
"required": true,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 2,
"type": "text",
"name": "address",
"label": "Address",
"description": null,
"value": "Nyborgshaven 6 G, 7.\n9015 Nibe",
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 3,
"type": "text",
"name": "zip_code",
"label": "Zip code",
"description": null,
"value": 4387,
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 4,
"type": "text",
"name": "city",
"label": "City",
"description": null,
"value": "Ansager",
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 5,
"type": "text",
"name": "state_region",
"label": "State/Region",
"description": null,
"value": "Aalborg",
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 6,
"type": "single_choice",
"name": "country",
"label": "Country",
"description": null,
"value": {
"id": 123,
"value": "DZ"
},
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 7,
"type": "text",
"name": "vat",
"label": "VAT",
"description": null,
"value": 29295865995,
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 8,
"type": "text",
"name": "website",
"label": "Website",
"description": null,
"value": "http://Schou.com/",
"validation": "url",
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
}
],
"custom_fields": [
{
"id": 1,
"type": "text",
"name": "email",
"label": "Custom E-mail",
"description": null,
"value": null,
"validation": "email",
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 18
},
{
"id": 2,
"type": "numeric",
"name": "number",
"label": "Custom Number",
"description": null,
"value": null,
"validation": "numeric",
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 17
},
{
"id": 3,
"type": "date",
"name": "date",
"label": "Custom Date",
"description": null,
"value": null,
"validation": "date",
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 16
},
{
"id": 4,
"type": "boolean",
"name": "boolean",
"label": "Custom Boolean",
"description": null,
"value": null,
"validation": "boolean",
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 15
},
{
"id": 5,
"type": "single_choice",
"name": "single_choice",
"label": "Custom Single Choice",
"description": null,
"value": null,
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 14
},
{
"id": 6,
"type": "multiple_choice",
"name": "multiple_choice",
"label": "Custom Multiple Choice",
"description": null,
"value": null,
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 13
}
],
"created_at": "2015-02-24 12:34:56",
"updated_at": "2015-02-24 12:34:56",
"latest_activity_at": null
},
"contact": {
"id": "4e6b1824-2ae1-32b7-988a-bc3761702bf1",
"b2c": false,
"account": {
"id": "2f215f8b-b98d-3c62-b812-68c89dc26ff3",
"name": "Andreassen og Danielsen A/S"
},
"user": {
"id": 14,
"first_name": "Agustin",
"last_name": "Hettinger",
"phone_number": "(378) 277-9381 x796",
"job_title": "Director, Data Science",
"email": "12@example.com",
"email_notifications": false,
"profile_picture": null,
"system_user": false,
"created_at": "2018-07-27 22:31:10",
"updated_at": "2018-12-21 15:24:37"
},
"team_id": 1,
"team": {
"id": 1,
"name": "Team 1",
"address_1": "Savannah 123",
"address_2": "Under the tree on the left",
"zip_code": "4730",
"city": "Umzimkulu",
"state": "KwaZulu-Natal",
"country": null,
"phone_number": "031 308 7900",
"website": "https://easir.com",
"vat": "1234567890123456",
"team_type": null,
"group_id": 1,
"use_social_lookup": false,
"created_at": "2014-01-01 12:45:56",
"updated_at": "2014-01-02 00:11:22"
},
"status": "customer",
"fixed_fields": [
{
"id": 10,
"type": "text",
"name": "salutation",
"label": "Salutation",
"description": null,
"value": "Dr.",
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 11,
"type": "text",
"name": "first_name",
"label": "First name",
"description": null,
"value": "Lars",
"validation": null,
"required": true,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 12,
"type": "text",
"name": "last_name",
"label": "Last name",
"description": null,
"value": "Olesen",
"validation": null,
"required": true,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 13,
"type": "text",
"name": "email",
"label": "Email",
"description": null,
"value": "Casper.Broberg@example.com",
"validation": "email",
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 14,
"type": "text",
"name": "landline_phone_number",
"label": "Landline phone number",
"description": null,
"value": "+45 47 57 78 84",
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 16,
"type": "text",
"name": "title",
"label": "Title",
"description": null,
"value": "Truck driver",
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 35,
"type": "text",
"name": "mobile_phone_number",
"label": "Mobile phone number",
"description": null,
"value": null,
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
},
{
"id": 37,
"type": "date",
"name": "date_of_birth",
"label": "Date of Birth",
"description": null,
"value": null,
"validation": "date_before_tomorrow",
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 0
}
],
"custom_fields": [
{
"id": 8,
"type": "text",
"name": "email",
"label": "Custom E-mail",
"description": null,
"value": null,
"validation": "email",
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 11
},
{
"id": 9,
"type": "numeric",
"name": "number",
"label": "Custom Number",
"description": null,
"value": null,
"validation": "numeric",
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 10
},
{
"id": 10,
"type": "date",
"name": "date",
"label": "Custom Date",
"description": null,
"value": null,
"validation": "date",
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 9
},
{
"id": 11,
"type": "single_choice",
"name": "single_choice",
"label": "Custom Single Choice",
"description": null,
"value": null,
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 8
},
{
"id": 12,
"type": "multiple_choice",
"name": "multiple_choice",
"label": "Custom Multiple Choice",
"description": null,
"value": null,
"validation": null,
"required": false,
"hidden": false,
"read_only": false,
"sort_order": 7
}
],
"created_at": "2015-02-24 12:34:56",
"updated_at": "2015-02-24 12:34:56",
"latest_activity_at": null,
"social_profile": {},
"consent": {
"email": {
"consent_given": true,
"updated_at": "2019-07-19 10:32:50"
},
"letter": {
"consent_given": true,
"updated_at": "2019-07-25 10:32:50"
},
"call": {
"consent_given": true,
"updated_at": "2019-07-18 10:32:50"
},
"sms": {
"consent_given": null,
"updated_at": null
}
}
},
"team": {
"id": 1,
"name": "Team 1",
"address_1": "Savannah 123",
"address_2": "Under the tree on the left",
"zip_code": "4730",
"city": "Umzimkulu",
"state": "KwaZulu-Natal",
"country": null,
"phone_number": "031 308 7900",
"website": "https://easir.com",
"vat": "1234567890123456",
"team_type": null,
"group_id": 1,
"use_social_lookup": false,
"created_at": "2014-01-01 12:45:56",
"updated_at": "2014-01-02 00:11:22"
},
"user": {
"id": 28,
"first_name": "Gerry",
"last_name": "Miller",
"phone_number": "507-954-5324 x7784",
"job_title": "Downstream Processing Scientist",
"email": "26@example.com",
"email_notifications": false,
"profile_picture": null,
"system_user": false,
"created_at": "2019-06-25 16:08:56",
"updated_at": "2019-07-13 06:40:36"
},
"next_task": {
"id": "ac9cc623-cf44-42db-b9d0-9d8f357d582d",
"type": "email",
"start_at": "2015-04-16 07:34:26",
"end_at": "2015-04-16 07:34:26"
},
"relations_path": {
"id": "9eae431b-3d0f-4528-9c59-e9d1a40fcd04",
"name": "Case type",
"is_sales_type": true
},
"chance_of_success": 8,
"milestones": [
{
"id": "a203539b-f06c-442c-8ad0-f5a56f0615f6",
"name": "Contract",
"description": null,
"done": true
},
{
"id": "943cef92-f9b4-4fcb-b4e4-834f34915973",
"name": "Milestone 2",
"description": null,
"done": false
}
],
"latest_milestone_name": null,
"latest_activity_at": "2019-07-23 10:33:06",
"latest_activity": null,
"estimated_close_date": "2019-11-14",
"lead_source": null,
"activity_count": 1,
"previous_case": null,
"next_case": null,
"escalates_at": null,
"created_at": "2015-02-24 12:34:56",
"updated_at": "2015-02-24 12:34:56"
}