Create a note
Creates a new note for a given record.
Required scopes: note:read-write
, object_configuration:read
, record_permission:read
.
curl --request POST \
--url https://api.attio.com/v2/notes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"data": {
"parent_object": "people",
"parent_record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d",
"title": "Initial Prospecting Call Summary",
"format": "plaintext",
"content": "# Meeting Recap: Q4 Planning\n\n**Date:** 2023-10-26\n**Attendees:** Alex, Jamie, Casey\n\n## Key Discussion Points\n\n- Reviewed Q3 performance metrics.\n- Brainstormed key initiatives for Q4.\n- Discussed budget allocation for ==Project Phoenix==.\n\n## Action Items\n\n1. Alex to finalize Q4 roadmap by EOD Friday.\n2. Jamie to schedule follow-up with [Marketing Team](https://app.attio.com/teams/marketing).\n3. Casey to draft initial budget for ~~Project Chimera~~ (now deferred).\n\n*Next steps: Review draft roadmap next week.*",
"created_at": "2023-01-01T15:00:00.000000000Z"
}
}'
{
"data": {
"id": {
"workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
"note_id": "ff3f3bd4-40f4-4f80-8187-cd02385af424"
},
"parent_object": "people",
"parent_record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d",
"title": "Initial Prospecting Call Summary",
"content_plaintext": "Introduction\nDate and time of the call\nParticipants\nPurpose of the call\nCustomer Background\nCompany overview (industry, size, location)\nKey business challenges\nCurrent software solutions (if any) and pain points",
"content_markdown": "# Introduction\nDate and time of the call\nParticipants\nPurpose of the call\n\n## Customer Background\n- Company overview (industry, size, location)\n- Key business challenges\n- Current software solutions (if any) and pain points",
"created_by_actor": {
"type": "workspace-member",
"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
},
"created_at": "2022-11-21T13:22:49.061281000Z"
}
}
Authorizations
This API uses OAuth 2.0 with the authorization code grant flow.
Body
The ID or slug of the parent object the note belongs to.
"people"
The ID of the parent record the note belongs to.
"891dcbfc-9141-415d-9b2a-2238a6cc012d"
The note title. The title is plaintext only and has no formatting.
"Initial Prospecting Call Summary"
Specify the format for the note's content. Choose from:
-
plaintext
: Standard text format where\n
signifies a new line. -
markdown
: Enables rich text formatting using a subset of Markdown syntax:- Headings: Levels 1-3 (
#
,##
,###
). - Lists: Unordered (
-
,*
,+
) and ordered (1.
,2.
). - Text styles: Bold (
**bold**
or__bold__
), italic (*italic*
or_italic_
), strikethrough (~~strikethrough~~
), and highlight (==highlighted==
). - Links: Standard Markdown links (
[link text](https://example.com)
).
Note: While the Attio interface supports image embeds, they cannot currently be added or retrieved via the API's markdown format.
- Headings: Levels 1-3 (
plaintext
, markdown
The main content of the note, formatted according to the value provided in the format
field. Use \n
for line breaks in plaintext
. For markdown
, utilize the supported syntax elements to structure and style your note.
"# Meeting Recap: Q4 Planning\n\n**Date:** 2023-10-26\n**Attendees:** Alex, Jamie, Casey\n\n## Key Discussion Points\n\n- Reviewed Q3 performance metrics.\n- Brainstormed key initiatives for Q4.\n- Discussed budget allocation for ==Project Phoenix==.\n\n## Action Items\n\n1. Alex to finalize Q4 roadmap by EOD Friday.\n2. Jamie to schedule follow-up with [Marketing Team](https://app.attio.com/teams/marketing).\n3. Casey to draft initial budget for ~~Project Chimera~~ (now deferred).\n\n*Next steps: Review draft roadmap next week.*"
created_at
will default to the current time. However, if you wish to backdate a note 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.
"2023-01-01T15:00:00.000000000Z"
Response
Success
The slug or ID of the parent object the note belongs to.
"people"
The ID of the parent record the note belongs to.
"891dcbfc-9141-415d-9b2a-2238a6cc012d"
The note title. The title is plaintext only and has no formatting.
"Initial Prospecting Call Summary"
The plaintext representation of the note content. The line feed character \n
represents new lines within the note content.
"Introduction\nDate and time of the call\nParticipants\nPurpose of the call\nCustomer Background\nCompany overview (industry, size, location)\nKey business challenges\nCurrent software solutions (if any) and pain points"
The markdown representation of the note content. Supports a subset of markdown features including:
- Headings (levels 1-3 only with
#
,##
,###
) - Unordered lists (
-
,*
,+
) - Ordered lists (
1.
,2.
, etc.) - Text styling:
**bold**
,*italic*
,~~strikethrough~~
,==highlighted==
- Links:
[link text](https://example.com)
Note that note images are not returned as part of the markdown API representation.
"# Introduction\nDate and time of the call\nParticipants\nPurpose of the call\n\n## Customer Background\n- Company overview (industry, size, location)\n- Key business challenges\n- Current software solutions (if any) and pain points"
The actor that created this note.
An ID to identify the actor.
The type of actor. Read more information on actor types here.
api-token
, workspace-member
, system
, app
{
"type": "workspace-member",
"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}
When the note was created.
"2022-11-21T13:22:49.061281000Z"
Was this page helpful?
curl --request POST \
--url https://api.attio.com/v2/notes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"data": {
"parent_object": "people",
"parent_record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d",
"title": "Initial Prospecting Call Summary",
"format": "plaintext",
"content": "# Meeting Recap: Q4 Planning\n\n**Date:** 2023-10-26\n**Attendees:** Alex, Jamie, Casey\n\n## Key Discussion Points\n\n- Reviewed Q3 performance metrics.\n- Brainstormed key initiatives for Q4.\n- Discussed budget allocation for ==Project Phoenix==.\n\n## Action Items\n\n1. Alex to finalize Q4 roadmap by EOD Friday.\n2. Jamie to schedule follow-up with [Marketing Team](https://app.attio.com/teams/marketing).\n3. Casey to draft initial budget for ~~Project Chimera~~ (now deferred).\n\n*Next steps: Review draft roadmap next week.*",
"created_at": "2023-01-01T15:00:00.000000000Z"
}
}'
{
"data": {
"id": {
"workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
"note_id": "ff3f3bd4-40f4-4f80-8187-cd02385af424"
},
"parent_object": "people",
"parent_record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d",
"title": "Initial Prospecting Call Summary",
"content_plaintext": "Introduction\nDate and time of the call\nParticipants\nPurpose of the call\nCustomer Background\nCompany overview (industry, size, location)\nKey business challenges\nCurrent software solutions (if any) and pain points",
"content_markdown": "# Introduction\nDate and time of the call\nParticipants\nPurpose of the call\n\n## Customer Background\n- Company overview (industry, size, location)\n- Key business challenges\n- Current software solutions (if any) and pain points",
"created_by_actor": {
"type": "workspace-member",
"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
},
"created_at": "2022-11-21T13:22:49.061281000Z"
}
}