1. API
  2. Cases
  3. Files

Files: Create

Last updated Open markdown version

Description

Attach a file to a case.

Request

HTTP Method: POST

Parameter Description
filename The name of the file to be added to the case.
file_contents Base64 encoded file contents to attach to the case.
value Optional The value of the comment to be added to the case. Supports markdown and mentioning users. To mention a user, use the notation <@user-2435>, replacing '2435' with the user ID.
author_email Optional The email of the user attaching the file to the case.
team_case_block_id Optional The ID of the file block to attach the file to.
Path Parameter Description
case_id The ID of the case.

Sample request

curl -X POST \
  https://<tenant-domain>/api/v2/cases/<<case_id>>/files \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>' \
  -d '{
        "filename": "Name of file",
        "file_contents": "QmFzZTY0IGVuY29kZWQgZlsZSBjb250ZW50cw==",
        "value": "This is a comment alongside a file attachment.",
        "team_case_block_id": 42
      }'

Response

A successful request will return a JSON object describing the activity taken on the case - file_attached in this instance.

Field description

Parameter Description
case_id The ID of the case.
id The ID of the record with the file attached to the case.
activity_type The type of activity taken on the case - file_attached or file_attached_and_commented in this instance.
value The comment added alongside file.
created_at ISO 8601 Timestamp representing creation date.
user Details of the user.
block_id Optional The ID of the block the file was attached to, if a block ID was specified.
User parameter Description
user_id The user ID.
first_name The user's first name.
last_name The user's last name.
email The user's email address.
avatar_url The user's avatar url.
is_service_account Whether this user is a service account (true/false).

Sample response

{
  "case_id": 42,
  "id": 7508,
  "activity_type": "FILE_ATTACHED_AND_COMMENTED",
  "value": "This is a comment alongside a file",
  "created_at": "2024-03-25T15:40:39Z",
  "file": {
    "filename": "hello.txt",
    "url": "http://<tenant-domain>/api/v2/cases/42/files/7508/download"
  },
  "user": {
    "user_id": 1,
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane@tines.io",
    "avatar_url": "example.com/avatar",
    "is_service_account": false
  },
  "block_id": "42"
}
Was this helpful?