Create a comment

curl --request POST \
  --url https://api.attio.com/v2/comments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "format": "plaintext",
    "content": "If I put the email address of my colleague on Attio in here, e.g. [email protected], they will be notified. Other emails (e.g. [email protected]) will be turned into clickable links.",
    "author": {
      "type": "workspace-member",
      "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
    },
    "thread_id": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2",
    "created_at": "2023-01-01T15:00:00.000000000Z"
  }
}
'

{
  "data": {
    "id": {
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
      "comment_id": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2"
    },
    "thread_id": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2",
    "content_plaintext": "Let's go ahead and close this deal, [email protected].",
    "entry": {
      "entry_id": "2e6e29ea-c4e0-4f44-842d-78a891f8c156",
      "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0"
    },
    "record": {
      "record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",
      "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795"
    },
    "resolved_at": "2023-01-01T15:00:00.000000000Z",
    "resolved_by": {
      "type": "workspace-member",
      "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
    },
    "created_at": "2023-01-01T15:00:00.000000000Z",
    "author": {
      "type": "workspace-member",
      "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
    }
  }
}

POST

comments

Create a comment

curl --request POST \
  --url https://api.attio.com/v2/comments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "format": "plaintext",
    "content": "If I put the email address of my colleague on Attio in here, e.g. [email protected], they will be notified. Other emails (e.g. [email protected]) will be turned into clickable links.",
    "author": {
      "type": "workspace-member",
      "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
    },
    "thread_id": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2",
    "created_at": "2023-01-01T15:00:00.000000000Z"
  }
}
'

{
  "data": {
    "id": {
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
      "comment_id": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2"
    },
    "thread_id": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2",
    "content_plaintext": "Let's go ahead and close this deal, [email protected].",
    "entry": {
      "entry_id": "2e6e29ea-c4e0-4f44-842d-78a891f8c156",
      "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0"
    },
    "record": {
      "record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",
      "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795"
    },
    "resolved_at": "2023-01-01T15:00:00.000000000Z",
    "resolved_by": {
      "type": "workspace-member",
      "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
    },
    "created_at": "2023-01-01T15:00:00.000000000Z",
    "author": {
      "type": "workspace-member",
      "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
    }
  }
}

Authorizations

Authorization

string

header

required

This API uses OAuth 2.0 with the authorization code grant flow.

Body

application/json

data

object

required

Option 1
Option 2
Option 3

Show child attributes

data.format

enum<string>

required

The format that the comment content is provided in. The plaintext format uses the line feed character \n to create new lines within the note content. Rich text formatting and links are not supported.

Available options:

plaintext

data.content

string

required

The content of the comment itself. Workspace members can be mentioned using their email address, otherwise email addresses will be presented to users as clickable mailto links.

Example:

"If I put the email address of my colleague on Attio in here, e.g. [email protected], they will be notified. Other emails (e.g. [email protected]) will be turned into clickable links."

data.author

object

required

The workspace member who wrote this comment. Note that other types of actors are not currently supported.

Show child attributes

data.author.type

enum<string>

required

Available options:

workspace-member

data.author.id

string<uuid>

required

Example:

{
  "type": "workspace-member",
  "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}

data.thread_id

string<uuid>

required

If responding to an existing thread, this would be the ID of that thread.

Example:

"aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2"

data.created_at

string

created_at will default to the current time. However, if you wish to backdate a comment for migration or other purposes, you can override with a custom created_at value. Note that dates before 1970 or in the future are not allowed.

Example:

"2023-01-01T15:00:00.000000000Z"

Response

Success

data

object

required

Show child attributes

data.id

object

required

Show child attributes

data.id.workspace_id

string<uuid>

required

The ID of the workspace the comment belongs to.

Example:

"14beef7a-99f7-4534-a87e-70b564330a4c"

data.id.comment_id

string<uuid>

required

The ID of the comment.

Example:

"aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2"

data.thread_id

string<uuid>

required

The ID of the thread the comment belongs to.

Example:

"aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2"

data.content_plaintext

string

required

A plaintext representation of the content of the comment. References to workspace members are cast into email addresses, all other stylistic elements are removed.

Example:

"Let's go ahead and close this deal, [email protected]."

data.entry

object

required

The entry the comment belongs to, null for comments on records.

Show child attributes

data.entry.entry_id

string<uuid>

required

The ID of the entry the comment belongs to.

Example:

"2e6e29ea-c4e0-4f44-842d-78a891f8c156"

data.entry.list_id

string<uuid>

required

The ID of the list the entry belongs to.

Example:

"33ebdbe9-e529-47c9-b894-0ba25e9c15c0"

data.record

object

required

The record the comment belongs to.

Show child attributes

data.record.record_id

string<uuid>

required

The ID of the record the comment belongs to.

Example:

"bf071e1f-6035-429d-b874-d83ea64ea13b"

data.record.object_id

string<uuid>

required

The ID of the object the record belongs to.

Example:

"97052eb9-e65e-443f-a297-f2d9a4a7f795"

data.resolved_at

string | null

required

Whether the comment is resolved.

Example:

"2023-01-01T15:00:00.000000000Z"

data.resolved_by

object

required

The actor that resolved this comment.

Show child attributes

data.resolved_by.id

string | null

An ID to identify the actor.

data.resolved_by.type

enum<string> | null

The type of actor. Read more information on actor types here.

Available options:

api-token,

workspace-member,

system,

app

Example:

{
  "type": "workspace-member",
  "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}

data.created_at

string

required

When the note was created.

Example:

"2023-01-01T15:00:00.000000000Z"

data.author

object

required

Who wrote this comment. Note that the API provides the ability for API tokens to write comments on behalf of other actors.

Show child attributes

data.author.id

string | null

An ID to identify the actor.

data.author.type

enum<string> | null

The type of actor. Read more information on actor types here.

Available options:

api-token,

workspace-member,

system,

app

Example:

{
  "type": "workspace-member",
  "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}

Get a thread Get a comment

⌘I

Introduction

Guides

Tutorials

Endpoint reference

Webhook reference

Create a comment

Authorizations

Body

Response