Sign in
Comments

Create a Comment

Create a new comment.

post/comments

Query parameters

fieldsstring[]

Control what fields are being returned in the object.

metastring

What metadata to return in the response.

Request body

collectionstring required

Which collection this collection comment is for.

itemstring required
commentstring required

Example request

{
  "collection": "projects",
  "item": "81dfa7e0-56d2-471f-b96a-1cf8a62bdf28",
  "comment": "A new comment"
}

Response

Successful request

Example response

{
  "data": {
    "id": "81dfa7e0-56d2-471f-b96a-1cf8a62bdf28",
    "collection": {
      "collection": "customers"
    },
    "item": "123",
    "comment": "This is a comment",
    "date_created": "2024-01-23T12:34:56Z",
    "date_updated": "2024-01-23T12:34:56Z",
    "user_created": {
      "id": "63716273-0f29-4648-8a2a-2af2948f6f78",
      "first_name": "Admin",
      "last_name": "User",
      "email": "admin@example.com",
      "avatar": {
        "id": "8cbb43fe-4cdf-4991-8352-c461779cec02",
        "storage": "local",
        "filename_disk": "a88c3b72-ac58-5436-a4ec-b2858531333a.jpg",
        "filename_download": "avatar.jpg",
        "title": "User Avatar",
        "type": "image/jpeg",
        "folder": {
          "id": "0cf0e03d-4364-45df-b77b-ca61f61869d2",
          "name": "New York"
        },
        "created_on": "2019-12-03T00:10:15+00:00",
        "charset": "binary",
        "filesize": 137862,
        "width": 800,
        "height": 838,
        "uploaded_on": "2019-12-03T00:10:15+00:00"
      },
      "language": "en-US",
      "status": "active",
      "role": {
        "id": "2f24211d-d928-469a-aea3-3c8f53d4e426",
        "name": "Administrator",
        "icon": "verified_user",
        "description": "Admins have access to all managed data within the system by default"
      },
      "last_access": "2020-05-31T14:32:37Z",
      "last_page": "/my-project/settings/collections/a"
    },
    "user_updated": {
      "id": "63716273-0f29-4648-8a2a-2af2948f6f78",
      "first_name": "Admin",
      "last_name": "User",
      "email": "admin@example.com",
      "avatar": {
        "id": "8cbb43fe-4cdf-4991-8352-c461779cec02",
        "storage": "local",
        "filename_disk": "a88c3b72-ac58-5436-a4ec-b2858531333a.jpg",
        "filename_download": "avatar.jpg",
        "title": "User Avatar",
        "type": "image/jpeg",
        "folder": {
          "id": "0cf0e03d-4364-45df-b77b-ca61f61869d2",
          "name": "New York"
        },
        "created_on": "2019-12-03T00:10:15+00:00",
        "charset": "binary",
        "filesize": 137862,
        "width": 800,
        "height": 838,
        "uploaded_on": "2019-12-03T00:10:15+00:00"
      },
      "language": "en-US",
      "status": "active",
      "role": {
        "id": "2f24211d-d928-469a-aea3-3c8f53d4e426",
        "name": "Administrator",
        "icon": "verified_user",
        "description": "Admins have access to all managed data within the system by default"
      },
      "last_access": "2020-05-31T14:32:37Z",
      "last_page": "/my-project/settings/collections/a"
    }
  }
}

Changes