Cases

Get all cases

GET /cases

Query string parameters

  • show string
    • Can be one of mine, team
  • status string
    • Can be one of open, closed, declined
  • lead_types - Only show tasks with one of these lead type ids (comma separated)
  • created_from_lead - Boolean. If set to true, lead_types can't be used
  • relations_paths UUID - Only show tasks with one of these relations path ids (comma separated)

  • Supports Searching

  • Supports Pagination

Deprecated parameters

  • relations_path deprecated in favor of relations_paths
    • Removal: 2018/04/01

Response
Status code 200

Deprecated response

  • latest_milestone_name deprecated in favor of latest_activity
    • Removal: 2018/04/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"
      },
      "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 integer
    • Must be a contact id 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

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 of latest_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

Payload

{
  "user_id": 4,
  "contact_id": "e2ade531-5efc-e19b-1783-a69eb3f5c87b"
}

Response
Status code 200

Deprecated response

  • latest_milestone_name deprecated in favor of latest_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"
}

Find a case

GET /cases/:case_id

Response
Status code 200

Deprecated response

  • latest_milestone_name deprecated in favor of latest_activity
    • Removal: 2018/04/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"
  },
  "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,
  "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 of latest_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 array
    • files.* UUID

Payload

{
  "files": [
    "fad9e028-6223-4165-b103-38199eddb069"
  ]
}

Response
Status code 200

Deprecated response

  • latest_milestone_name deprecated in favor of latest_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 of latest_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 array
  • files.* 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 of latest_activity
    • Removal: 2018/04/01