Task Management Task Comments

Overview

This resource represents Task Comments - notes and updates added to Tasks. Comments can include text content and/or attachments.

Parameters

OAuth Scopes:

task_management_read

Name	Type	Read/Write	Description
account	Integer	Read	Account's ID related to Task Comment
task	UUID	Read	Task's ID to which Comment belongs
created_by	Object	Read	Polymorphic reference to creator (User or Application)
attachments	Array	Read	Array of Attachment IDs related to Comment
id	UUID	Read	Task Comment's ID
content	String	Read	Comment's text content
created_at	Time	Read	Comment's create time
updated_at	Time	Read	Comment's update time
canceled_at	Time	Read	Comment's cancellation time (null if not canceled)

task_management_write

Name	Type	Read/Write	Description	Constraints
account	Integer	Read	Account's ID related to Task Comment
task	UUID	Read	Task's ID to which Comment belongs
created_by	Object	Read	Polymorphic reference to creator (User or Application)
attachments	Array	Read	Array of Attachment IDs related to Comment
id	UUID	Read	Task Comment's ID
task_id	UUID	Write	Task's ID to add comment to	Required
content	String	Read/Write	Comment's text content	Required if no attachments provided
attachments	Array	Write	Array of attachment objects with file data (Base64 encoded)
created_at	Time	Read	Comment's create time
updated_at	Time	Read	Comment's update time
canceled_at	Time	Read	Comment's cancellation time (null if not canceled)

List Task Comments

GET /task_management/task_comments

OAuth Scopes:

task_management_read / task_management_write

response.json

{
  "links": {
    "task_comments.account": "https://www.bookingsync.com/api/v3/accounts/{task_comments.account}",
    "task_comments.task": "https://www.bookingsync.com/api/v3/task_management/tasks/{task_comments.task}",
    "task_comments.user": "https://www.bookingsync.com/api/v3/users/{task_comments.created_by.id}",
    "task_comments.application": "https://www.bookingsync.com/api/v3/applications/{task_comments.created_by.id}"
  },
  "task_comments": [
    {
      "links": {
        "account": 1,
        "task": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "created_by": {
          "id": 5,
          "type": "User"
        },
        "attachments": []
      },
      "id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
      "content": "Started working on the task. Everything looks good so far.",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "canceled_at": null
    }
  ],
  "meta": {}
}

Get a single Task Comment

Returns a single task comment identified by ID.

GET /task_management/task_comments/:task_comment_id

OAuth Scopes:

task_management_read / task_management_write

response.json

{
  "links": {
    "task_comments.account": "https://www.bookingsync.com/api/v3/accounts/{task_comments.account}",
    "task_comments.task": "https://www.bookingsync.com/api/v3/task_management/tasks/{task_comments.task}",
    "task_comments.user": "https://www.bookingsync.com/api/v3/users/{task_comments.created_by.id}",
    "task_comments.application": "https://www.bookingsync.com/api/v3/applications/{task_comments.created_by.id}"
  },
  "task_comments": [
    {
      "links": {
        "account": 1,
        "task": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "created_by": {
          "id": 5,
          "type": "User"
        },
        "attachments": []
      },
      "id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
      "content": "Started working on the task. Everything looks good so far.",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "canceled_at": null
    }
  ],
  "meta": {}
}

Create a new Task Comment

Creates a Task Comment.

POST /task_management/task_comments

OAuth Scopes:

task_management_write

request.json

{
  "task_comments": [
    {
      "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "content": "Started working on the task. Everything looks good so far."
    }
  ]
}

response.json

{
  "links": {
    "task_comments.account": "https://www.bookingsync.com/api/v3/accounts/{task_comments.account}",
    "task_comments.task": "https://www.bookingsync.com/api/v3/task_management/tasks/{task_comments.task}",
    "task_comments.user": "https://www.bookingsync.com/api/v3/users/{task_comments.created_by.id}",
    "task_comments.application": "https://www.bookingsync.com/api/v3/applications/{task_comments.created_by.id}"
  },
  "task_comments": [
    {
      "links": {
        "account": 1,
        "task": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "created_by": {
          "id": 5,
          "type": "User"
        },
        "attachments": []
      },
      "id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
      "content": "Started working on the task. Everything looks good so far.",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "canceled_at": null
    }
  ],
  "meta": {}
}

Content or Attachments Required

Either content or attachments must be provided when creating a Task Comment. You can provide both.