Batch update

Description

Update the actions on a case. This request will replace any existing actions on the case.

Request

HTTP Method: PUT

Actions Parameter Description
url The URL of the case action (webhook or page URL).
label User specified field to identify the case action.
action_type The case action type (webhook or page).
action_text Optional The text for the button to execute the action.
Path Parameter Description
case_id The ID of the case.

Sample request

curl -X PUT \
  https://<<META.tenant.domain>>/api/v2/cases/<<case_id>>/actions/batch \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>' \
  -d '{
        "actions": [
          {
            "url": "https://tenant.tines.com/pages/123",
            "label": "Complete request",
            "action_type": "page",
            "action_text": "Open"
          },
          {
            "url": "https://tenant.tines.com/webhook/abc",
            "label": "Claim case",
            "action_type": "webhook",
            "action_text": "Run"
          }
        ]
      }'

Response

A successful request will return a JSON object describing the updated case action.

Field description

Parameter Description
case_id The ID of the case.
actions An array of the actions on a case.
Action object Description
id The case action ID.
url The URL of the case action.
label The label of the case action.
action_type The case action type (webhook or page).
action_text The text for the button to execute the action.
story_name Will be populated if the URL matches that of a page or webhook in an existing story.
story_emoji The associated story's emoji icon.
page_emoji The associated page's emoji icon.
created_at ISO 8601 Timestamp representing creation date and time of the case action.
updated_at ISO 8601 Timestamp representing last updated date and time of case action.

Sample response

{
  "case_id": 42,
  "actions": [
    {
      "id": 1,
      "url": "https://tenant.tines.com/webhook/abc",
      "label": "Claim case",
      "story_name": "Case Management",
      "story_emoji": ":fire:",
      "page_emoji": null,
      "action_type": "webhook",
      "action_text": "Run",
      "created_at": "2023-10-31T15:42:00Z",
      "updated_at": "2023-10-31T16:42:00Z"
    },
    {
      "id": 1,
      "url": "https://tenant.tines.com/pages/123",
      "label": "Complete request",
      "story_name": "Case Management",
      "story_emoji": ":fire:",
      "page_emoji": ":fire:",
      "action_type": "page",
      "action_text": "Open page",
      "created_at": "2023-10-31T15:42:00Z",
      "updated_at": "2023-10-31T16:42:00Z"
    }
  ]
}
Was this helpful?