Zoho Notebook
App · Notes · 20 actions
Note-taking from Zoho. Create and organise notebooks and notecards, write rich-text, plain-text and image notes, and tag them.
Actions
| Action | What it does |
|---|---|
| Add tags to a notecard | Add one or more tags to a notecard. |
| Create a notebook | Create a notebook with a name and an optional description. |
| Create a notecard | Create a text notecard in a notebook. |
| Create a plain-text notecard | Create a notecard from plain text, kept exactly as written: nothing in it is read as HTML. |
| Create a tag | Create a tag. |
| Create an image notecard | Create a notecard holding one PNG or JPEG image, up to 10 MB. |
| Delete a tag | Delete a tag. |
| Get a notebook | Get a notebook's name, description, dates and owner. |
| Get a notecard | Get a notecard's title, colour, notebook and content as HTML. |
| List notebooks | List the notebooks in the connected Zoho Notebook account. |
| List notecards | List the notecards in a notebook, with each one's id, title, colour and content as HTML. |
| List tags | List the tags in the connected Zoho Notebook account. |
| Move a notebook to the trash | Move a notebook and every notecard in it to the trash. |
| Move a notecard to another notebook | Move a notecard into another notebook. |
| Move a notecard to the trash | Move a notecard to the trash. |
| Permanently delete from the trash | Permanently delete a notebook or notecard that is already in the trash. |
| Remove a tag from a notecard | Remove one tag from a notecard. |
| Rename a tag | Rename a tag. |
| Update a notebook | Rename a notebook, change its description, or lock or unlock it. |
| Update a notecard | Rename, recolour or rewrite a text notecard. |
Add tags to a notecard
Add one or more tags to a notecard. Tags it already has are kept.
Inputs
- Notecard ID
notecard_idtextRequired - The notecard's id, from 'List notecards' or an earlier step.
- Tags
tag_idslistRequired - The tags to add, from the list or as ids from 'List tags'.
Outputs
The tags added to the notecard.
notecard_idtext- The notecard's id.
tag_idslist- The ids of the tags just added.
Example output
{
"notecard_id": "xfalbcfe652e28467469c9736ebc689540f9b",
"tag_ids": [
"5b9968918b9c41678be582bf12f4831c"
]
}Create a notebook
Create a notebook with a name and an optional description.
Inputs
- Name
nametextRequired - The notebook's name. Names need not be unique.
- Description
descriptiontext - Optional. A short description of the notebook.
Outputs
A notebook.
cover_image_idtext- The id of the notebook's cover image.
created_bytext- The creator's Zoho account id.
created_by_user_detailsobject- A Zoho user.
created_timetext- When it was created, e.g. 2026-10-06T08:46:20-0700.
descriptiontext- The notebook's description.
is_defaulttrue/false- Whether this is the account's default notebook.
is_trashedtrue/false- Whether it is in the trash.
last_accessed_timetext- When it was last opened.
modified_bytext- The last editor's Zoho account id.
modified_by_user_detailsobject- A Zoho user.
modified_timetext- When it last changed.
nametext- The notebook's name.
notebook_idtext- The notebook's id.
ordernumber- Its position in the custom order.
parent_idtext- The parent's id; -1 for a top-level notebook.
Example output
{
"cover_image_id": "0whim4b2517bef2ab4039a51a33729d398ee7",
"created_by": "900000001",
"created_time": "2026-10-06T08:46:20-0700",
"description": "Weekly team meetings",
"is_default": false,
"last_accessed_time": "2026-10-06T08:46:20-0700",
"modified_by": "900000001",
"modified_time": "2026-10-06T08:46:20-0700",
"name": "Meeting notes",
"notebook_id": "xfalbae1b418e370f4f30bc1c8f7be6542022",
"order": 10000.0
}Create a notecard
Create a text notecard in a notebook. The content can be plain text or HTML such as <b>bold</b> and <a href>links</a>.
Inputs
- Notebook
notebook_idtextRequired - The notebook, from the list or as its id from 'List notebooks'.
- Title
nametextRequired - The notecard's title.
- Content
contenttextRequired - The note's text or HTML. Plain text keeps its line breaks. Up to 60,000 characters.
- Colour
colortext - Optional. The notecard's colour.One of:
#D9E8F0(Light blue),#FFFFFF(White),#FFF59D(Yellow),#FFB47A(Orange),#F4C2C2(Pink),#FFCDD2(Rose),#C5E1A5(Green),#B2EBF2(Cyan),#E1BEE7(Lavender),#CFD8DC(Grey).
Outputs
A notecard.
colortext- The notecard's colour, e.g. #D9E8F0.
created_bytext- The creator's Zoho account id.
created_by_user_detailsobject- A Zoho user.
created_timetext- When it was created, e.g. 2026-10-06T08:47:05-0700.
descriptiontext- The notecard's content, as HTML.
embed_resourceslist- Files embedded in the notecard, such as its image.
is_collectiontrue/false- Whether it is a collection.
is_taggedtrue/false- Whether it has any tags.
is_trashedtrue/false- Whether it is in the trash.
last_accessed_timetext- When it was last opened.
latitudenumber- Latitude it was made at.
locationtext- Where it was made; usually Unknown.
longitudenumber- Longitude it was made at.
modified_bytext- The last editor's Zoho account id.
modified_by_user_detailsobject- A Zoho user.
modified_timetext- When it last changed.
nametext- The notecard's title.
notebook_idtext- The id of the notebook it is in.
notecard_idtext- The notecard's id.
ordernumber- Its position in the notebook's custom order.
sizenumber- Its size in bytes.
typetext- The kind of notecard: note/mixed (text) or note/image.
Example output
{
"color": "#D9E8F0",
"created_by": "900000001",
"created_time": "2026-10-06T08:47:05-0700",
"description": "<div><div>Review the roadmap</div></div>",
"embed_resources": [],
"is_collection": false,
"last_accessed_time": "2026-10-06T08:47:05-0700",
"latitude": 0.0,
"location": "Unknown",
"longitude": 0.0,
"modified_by": "900000001",
"modified_time": "2026-10-06T08:47:05-0700",
"name": "Agenda",
"notebook_id": "xfalbae1b418e370f4f30bc1c8f7be6542022",
"notecard_id": "xfalbcfe652e28467469c9736ebc689540f9b",
"order": 20000.0,
"size": 455,
"type": "note/mixed"
}Create a plain-text notecard
Create a notecard from plain text, kept exactly as written: nothing in it is read as HTML.
Inputs
- Notebook
notebook_idtextRequired - The notebook, from the list or as its id from 'List notebooks'.
- Title
nametextRequired - The notecard's title.
- Text
texttextRequired - The note's text. Each line becomes a line of the note.
Outputs
A notecard.
colortext- The notecard's colour, e.g. #D9E8F0.
created_bytext- The creator's Zoho account id.
created_by_user_detailsobject- A Zoho user.
created_timetext- When it was created, e.g. 2026-10-06T08:47:05-0700.
descriptiontext- The notecard's content, as HTML.
embed_resourceslist- Files embedded in the notecard, such as its image.
is_collectiontrue/false- Whether it is a collection.
is_taggedtrue/false- Whether it has any tags.
is_trashedtrue/false- Whether it is in the trash.
last_accessed_timetext- When it was last opened.
latitudenumber- Latitude it was made at.
locationtext- Where it was made; usually Unknown.
longitudenumber- Longitude it was made at.
modified_bytext- The last editor's Zoho account id.
modified_by_user_detailsobject- A Zoho user.
modified_timetext- When it last changed.
nametext- The notecard's title.
notebook_idtext- The id of the notebook it is in.
notecard_idtext- The notecard's id.
ordernumber- Its position in the notebook's custom order.
sizenumber- Its size in bytes.
typetext- The kind of notecard: note/mixed (text) or note/image.
Example output
{
"color": "#D9E8F0",
"created_by": "900000001",
"created_time": "2026-10-06T08:47:05-0700",
"description": "<div><div>Review the roadmap</div></div>",
"embed_resources": [],
"is_collection": false,
"last_accessed_time": "2026-10-06T08:47:05-0700",
"latitude": 0.0,
"location": "Unknown",
"longitude": 0.0,
"modified_by": "900000001",
"modified_time": "2026-10-06T08:47:05-0700",
"name": "Agenda",
"notebook_id": "xfalbae1b418e370f4f30bc1c8f7be6542022",
"notecard_id": "xfalbcfe652e28467469c9736ebc689540f9b",
"order": 20000.0,
"size": 455,
"type": "note/mixed"
}Create a tag
Create a tag. If a tag with that name already exists, Zoho returns the existing one.
Inputs
- Tag name
nametextRequired - Letters and digits only: Zoho Notebook refuses spaces, hyphens and other characters in tag names.
Outputs
A tag.
created_timetext- When it was created, in Unix milliseconds.
nametext- The tag's name.
tag_idtext- The tag's id.
Example output
{
"created_time": "1791301747286",
"name": "roadmap",
"tag_id": "5b9968918b9c41678be582bf12f4831c"
}Create an image notecard
Create a notecard holding one PNG or JPEG image, up to 10 MB.
Inputs
- Notebook
notebook_idtextRequired - The notebook, from the list or as its id from 'List notebooks'.
- Title
nametextRequired - The notecard's title.
- Image
imagetextRequired - The image: upload a file, pick one from an earlier step, or paste a public image URL.
Outputs
A notecard.
colortext- The notecard's colour, e.g. #D9E8F0.
created_bytext- The creator's Zoho account id.
created_by_user_detailsobject- A Zoho user.
created_timetext- When it was created, e.g. 2026-10-06T08:47:05-0700.
descriptiontext- The notecard's content, as HTML.
embed_resourceslist- Files embedded in the notecard, such as its image.
is_collectiontrue/false- Whether it is a collection.
is_taggedtrue/false- Whether it has any tags.
is_trashedtrue/false- Whether it is in the trash.
last_accessed_timetext- When it was last opened.
latitudenumber- Latitude it was made at.
locationtext- Where it was made; usually Unknown.
longitudenumber- Longitude it was made at.
modified_bytext- The last editor's Zoho account id.
modified_by_user_detailsobject- A Zoho user.
modified_timetext- When it last changed.
nametext- The notecard's title.
notebook_idtext- The id of the notebook it is in.
notecard_idtext- The notecard's id.
ordernumber- Its position in the notebook's custom order.
sizenumber- Its size in bytes.
typetext- The kind of notecard: note/mixed (text) or note/image.
Example output
{
"color": "#D9E8F0",
"created_by": "900000001",
"created_time": "2026-10-06T08:47:05-0700",
"description": "<div></div>",
"embed_resources": [
{
"format": "image/png",
"resource_id": "xfalb6c8d6dd4f8ae41e48dd4839a4a6f4e05"
}
],
"is_collection": false,
"last_accessed_time": "2026-10-06T08:47:05-0700",
"latitude": 0.0,
"location": "Unknown",
"longitude": 0.0,
"modified_by": "900000001",
"modified_time": "2026-10-06T08:47:05-0700",
"name": "Whiteboard",
"notebook_id": "xfalbae1b418e370f4f30bc1c8f7be6542022",
"notecard_id": "xfalbcfe652e28467469c9736ebc689540f9b",
"order": 20000.0,
"size": 455,
"type": "note/image"
}Delete a tag
Delete a tag. The notecards that had it are kept.
Inputs
- Tag
tag_idtextRequired - The tag, from the list or as its id from 'List tags'.
Outputs
The deleted tag.
deletedtrue/false- Always true.
messagetext- Zoho's confirmation.
tag_idtext- The tag's id.
Example output
{
"deleted": true,
"message": "Tag(s) deleted successfully",
"tag_id": "5b9968918b9c41678be582bf12f4831c"
}Get a notebook
Get a notebook's name, description, dates and owner.
Inputs
- Notebook
notebook_idtextRequired - The notebook, from the list or as its id from 'List notebooks'.
Outputs
A notebook.
cover_image_idtext- The id of the notebook's cover image.
created_bytext- The creator's Zoho account id.
created_by_user_detailsobject- A Zoho user.
created_timetext- When it was created, e.g. 2026-10-06T08:46:20-0700.
descriptiontext- The notebook's description.
is_defaulttrue/false- Whether this is the account's default notebook.
is_trashedtrue/false- Whether it is in the trash.
last_accessed_timetext- When it was last opened.
modified_bytext- The last editor's Zoho account id.
modified_by_user_detailsobject- A Zoho user.
modified_timetext- When it last changed.
nametext- The notebook's name.
notebook_idtext- The notebook's id.
ordernumber- Its position in the custom order.
parent_idtext- The parent's id; -1 for a top-level notebook.
Example output
{
"cover_image_id": "0whim4b2517bef2ab4039a51a33729d398ee7",
"created_by": "900000001",
"created_by_user_details": {
"display_name": "Ada Lovelace",
"email_id": "ada@example.com",
"full_name": "Ada Lovelace",
"zuid": "900000001"
},
"created_time": "2026-10-06T08:46:20-0700",
"description": "Weekly team meetings",
"is_default": false,
"is_trashed": false,
"last_accessed_time": "2026-10-06T08:46:20-0700",
"modified_by": "900000001",
"modified_by_user_details": {
"display_name": "Ada Lovelace",
"email_id": "ada@example.com",
"full_name": "Ada Lovelace",
"zuid": "900000001"
},
"modified_time": "2026-10-06T08:46:20-0700",
"name": "Meeting notes",
"notebook_id": "xfalbae1b418e370f4f30bc1c8f7be6542022",
"order": 10000.0,
"parent_id": "-1"
}Get a notecard
Get a notecard's title, colour, notebook and content as HTML.
Inputs
- Notecard ID
notecard_idtextRequired - The notecard's id, from 'List notecards' or an earlier step.
Outputs
A notecard.
colortext- The notecard's colour, e.g. #D9E8F0.
created_bytext- The creator's Zoho account id.
created_by_user_detailsobject- A Zoho user.
created_timetext- When it was created, e.g. 2026-10-06T08:47:05-0700.
descriptiontext- The notecard's content, as HTML.
embed_resourceslist- Files embedded in the notecard, such as its image.
is_collectiontrue/false- Whether it is a collection.
is_taggedtrue/false- Whether it has any tags.
is_trashedtrue/false- Whether it is in the trash.
last_accessed_timetext- When it was last opened.
latitudenumber- Latitude it was made at.
locationtext- Where it was made; usually Unknown.
longitudenumber- Longitude it was made at.
modified_bytext- The last editor's Zoho account id.
modified_by_user_detailsobject- A Zoho user.
modified_timetext- When it last changed.
nametext- The notecard's title.
notebook_idtext- The id of the notebook it is in.
notecard_idtext- The notecard's id.
ordernumber- Its position in the notebook's custom order.
sizenumber- Its size in bytes.
typetext- The kind of notecard: note/mixed (text) or note/image.
Example output
{
"color": "#D9E8F0",
"created_by": "900000001",
"created_by_user_details": {
"display_name": "Ada Lovelace",
"email_id": "ada@example.com",
"full_name": "Ada Lovelace",
"zuid": "900000001"
},
"created_time": "2026-10-06T08:47:05-0700",
"description": "<div><div>Review the roadmap</div></div>",
"embed_resources": [],
"is_collection": false,
"is_tagged": true,
"is_trashed": false,
"last_accessed_time": "2026-10-06T08:47:05-0700",
"latitude": 0.0,
"location": "Unknown",
"longitude": 0.0,
"modified_by": "900000001",
"modified_by_user_details": {
"display_name": "Ada Lovelace",
"email_id": "ada@example.com",
"full_name": "Ada Lovelace",
"zuid": "900000001"
},
"modified_time": "2026-10-06T08:47:05-0700",
"name": "Agenda",
"notebook_id": "xfalbae1b418e370f4f30bc1c8f7be6542022",
"notecard_id": "xfalbcfe652e28467469c9736ebc689540f9b",
"order": 20000.0,
"size": 455,
"type": "note/mixed"
}List notebooks
List the notebooks in the connected Zoho Notebook account.
Inputs
- Order
sort_bytext - Optional. The order to return notebooks in.One of:
Notebook.CustomOrder(Your custom order),-Notebook.LastModifiedTime(Recently changed first),-Notebook.CreatedTime(Newest first),Notebook.CreatedTime(Oldest first),Notebook.Alphabet(Name, A to Z),-Notebook.LastAccessed(Recently opened first). - How many
limitnumber - Optional. How many to return, 1 to 999.From 1 to 999.
- Skip
offsetnumber - Optional. How many to skip first, for the next page.At least 0.
Outputs
A page of notebooks.
countnumber- How many notebooks this page holds.
has_moretrue/false- Whether another page may follow (the page was full).
itemslist- The notebooks.
limitnumber- The page size Zoho applied.
offsetnumber- How many were skipped before this page.
Example output
{
"count": 1,
"has_more": false,
"items": [
{
"cover_image_id": "0whim4b2517bef2ab4039a51a33729d398ee7",
"created_by": "900000001",
"created_time": "2026-10-06T08:46:20-0700",
"description": "Weekly team meetings",
"is_default": false,
"last_accessed_time": "2026-10-06T08:46:20-0700",
"modified_by": "900000001",
"modified_time": "2026-10-06T08:46:20-0700",
"name": "Meeting notes",
"notebook_id": "xfalbae1b418e370f4f30bc1c8f7be6542022",
"order": 10000.0
}
],
"limit": 100,
"offset": 0
}List notecards
List the notecards in a notebook, with each one's id, title, colour and content as HTML.
Inputs
- Notebook
notebook_idtextRequired - The notebook, from the list or as its id from 'List notebooks'.
- Order
sort_bytext - Optional. The order to return notecards in.One of:
Notecard.CustomOrder(Your custom order),-Notecard.LastModifiedTime(Recently changed first),-Notecard.CreatedTime(Newest first),Notecard.CreatedTime(Oldest first),Notecard.Alphabet(Name, A to Z). - How many
limitnumber - Optional. How many to return, 1 to 999.From 1 to 999.
- Skip
offsetnumber - Optional. How many to skip first, for the next page.At least 0.
Outputs
A page of notecards.
countnumber- How many notecards this page holds.
has_moretrue/false- Whether another page may follow (the page was full).
itemslist- The notecards.
limitnumber- The page size Zoho applied.
offsetnumber- How many were skipped before this page.
Example output
{
"count": 1,
"has_more": false,
"items": [
{
"color": "#D9E8F0",
"created_by": "900000001",
"created_time": "2026-10-06T08:47:05-0700",
"description": "<div><div>Review the roadmap</div></div>",
"embed_resources": [],
"is_collection": false,
"last_accessed_time": "2026-10-06T08:47:05-0700",
"latitude": 0.0,
"location": "Unknown",
"longitude": 0.0,
"modified_by": "900000001",
"modified_time": "2026-10-06T08:47:05-0700",
"name": "Agenda",
"notebook_id": "xfalbae1b418e370f4f30bc1c8f7be6542022",
"notecard_id": "xfalbcfe652e28467469c9736ebc689540f9b",
"order": 20000.0,
"size": 455,
"type": "note/mixed"
}
],
"limit": 100,
"offset": 0
}List tags
List the tags in the connected Zoho Notebook account.
Inputs
None.
Outputs
A page of tags.
countnumber- How many tags this page holds.
has_moretrue/false- Whether another page may follow (the page was full).
itemslist- The tags.
limitnumber- The page size Zoho applied.
offsetnumber- How many were skipped before this page.
Example output
{
"count": 1,
"has_more": false,
"items": [
{
"name": "roadmap",
"tag_id": "5b9968918b9c41678be582bf12f4831c"
}
],
"limit": 100,
"offset": 0
}Move a notebook to the trash
Move a notebook and every notecard in it to the trash. It stays there until 'Permanently delete from the trash' removes it.
Inputs
- Notebook
notebook_idtextRequired - The notebook, from the list or as its id from 'List notebooks'.
Outputs
The notebook moved to the trash.
messagetext- Zoho's confirmation.
notebook_idtext- The notebook's id.
trashedtrue/false- Always true.
Example output
{
"message": "Notebook(s) trashed successfully",
"notebook_id": "xfalbae1b418e370f4f30bc1c8f7be6542022",
"trashed": true
}Move a notecard to another notebook
Move a notecard into another notebook.
Inputs
- Notecard ID
notecard_idtextRequired - The notecard's id, from 'List notecards' or an earlier step.
- To notebook
to_notebook_idtextRequired - The notebook to move the notecard into.
Outputs
A notecard.
colortext- The notecard's colour, e.g. #D9E8F0.
created_bytext- The creator's Zoho account id.
created_by_user_detailsobject- A Zoho user.
created_timetext- When it was created, e.g. 2026-10-06T08:47:05-0700.
descriptiontext- The notecard's content, as HTML.
embed_resourceslist- Files embedded in the notecard, such as its image.
is_collectiontrue/false- Whether it is a collection.
is_taggedtrue/false- Whether it has any tags.
is_trashedtrue/false- Whether it is in the trash.
last_accessed_timetext- When it was last opened.
latitudenumber- Latitude it was made at.
locationtext- Where it was made; usually Unknown.
longitudenumber- Longitude it was made at.
modified_bytext- The last editor's Zoho account id.
modified_by_user_detailsobject- A Zoho user.
modified_timetext- When it last changed.
nametext- The notecard's title.
notebook_idtext- The id of the notebook it is in.
notecard_idtext- The notecard's id.
ordernumber- Its position in the notebook's custom order.
sizenumber- Its size in bytes.
typetext- The kind of notecard: note/mixed (text) or note/image.
Example output
{
"color": "#D9E8F0",
"created_by": "900000001",
"created_by_user_details": {
"display_name": "Ada Lovelace",
"email_id": "ada@example.com",
"full_name": "Ada Lovelace",
"zuid": "900000001"
},
"created_time": "2026-10-06T08:47:05-0700",
"description": "<div><div>Review the roadmap</div></div>",
"embed_resources": [],
"is_collection": false,
"is_tagged": true,
"is_trashed": false,
"last_accessed_time": "2026-10-06T08:47:05-0700",
"latitude": 0.0,
"location": "Unknown",
"longitude": 0.0,
"modified_by": "900000001",
"modified_by_user_details": {
"display_name": "Ada Lovelace",
"email_id": "ada@example.com",
"full_name": "Ada Lovelace",
"zuid": "900000001"
},
"modified_time": "2026-10-06T08:47:05-0700",
"name": "Agenda",
"notebook_id": "xfalbae1b418e370f4f30bc1c8f7be6542022",
"notecard_id": "xfalbcfe652e28467469c9736ebc689540f9b",
"order": 20000.0,
"size": 455,
"type": "note/mixed"
}Move a notecard to the trash
Move a notecard to the trash. It stays there until 'Permanently delete from the trash' removes it.
Inputs
- Notecard ID
notecard_idtextRequired - The notecard's id, from 'List notecards' or an earlier step.
Outputs
The notecard moved to the trash.
messagetext- Zoho's confirmation.
notecard_idtext- The notecard's id.
trashedtrue/false- Always true.
Example output
{
"message": "Notecard(s) trashed successfully",
"notecard_id": "xfalbcfe652e28467469c9736ebc689540f9b",
"trashed": true
}Permanently delete from the trash
Permanently delete a notebook or notecard that is already in the trash. This cannot be undone.
Inputs
- Notebook or notecard ID
item_idtextRequired - The id of the trashed notebook or notecard, from the step that moved it to the trash.
Outputs
The item permanently deleted from the trash.
deletedtrue/false- Always true.
item_idtext- The notebook's or notecard's id.
messagetext- Zoho's confirmation.
Example output
{
"deleted": true,
"item_id": "xfalbcfe652e28467469c9736ebc689540f9b",
"message": "Deleted from trash successfully"
}Remove a tag from a notecard
Remove one tag from a notecard. The tag itself is kept.
Inputs
- Notecard ID
notecard_idtextRequired - The notecard's id, from 'List notecards' or an earlier step.
- Tag
tag_idtextRequired - The tag, from the list or as its id from 'List tags'.
Outputs
The tag removed from the notecard.
messagetext- Zoho's confirmation.
notecard_idtext- The notecard's id.
removedtrue/false- Always true.
tag_idtext- The tag's id.
Example output
{
"message": "Tag(s) de-associated successfully",
"notecard_id": "xfalbcfe652e28467469c9736ebc689540f9b",
"removed": true,
"tag_id": "5b9968918b9c41678be582bf12f4831c"
}Rename a tag
Rename a tag. Notecards that have it keep it.
Inputs
- Tag
tag_idtextRequired - The tag, from the list or as its id from 'List tags'.
- New name
nametextRequired - Letters and digits only: Zoho Notebook refuses spaces, hyphens and other characters in tag names.
Outputs
A tag.
created_timetext- When it was created, in Unix milliseconds.
nametext- The tag's name.
tag_idtext- The tag's id.
Example output
{
"name": "roadmap",
"tag_id": "5b9968918b9c41678be582bf12f4831c"
}Update a notebook
Rename a notebook, change its description, or lock or unlock it. Only what you fill in changes.
Inputs
- Notebook
notebook_idtextRequired - The notebook, from the list or as its id from 'List notebooks'.
- New name
nametext - Optional. The notebook's new name.
- New description
descriptiontext - Optional. The notebook's new description.
- Locked
is_lockedtext - Optional. Lock or unlock the notebook. Leave empty to keep it as it is.One of:
true(Locked),false(Unlocked).
Outputs
A notebook.
cover_image_idtext- The id of the notebook's cover image.
created_bytext- The creator's Zoho account id.
created_by_user_detailsobject- A Zoho user.
created_timetext- When it was created, e.g. 2026-10-06T08:46:20-0700.
descriptiontext- The notebook's description.
is_defaulttrue/false- Whether this is the account's default notebook.
is_trashedtrue/false- Whether it is in the trash.
last_accessed_timetext- When it was last opened.
modified_bytext- The last editor's Zoho account id.
modified_by_user_detailsobject- A Zoho user.
modified_timetext- When it last changed.
nametext- The notebook's name.
notebook_idtext- The notebook's id.
ordernumber- Its position in the custom order.
parent_idtext- The parent's id; -1 for a top-level notebook.
Example output
{
"cover_image_id": "0whim4b2517bef2ab4039a51a33729d398ee7",
"created_by": "900000001",
"created_time": "2026-10-06T08:46:20-0700",
"description": "Weekly team meetings",
"is_default": false,
"last_accessed_time": "2026-10-06T08:46:20-0700",
"modified_by": "900000001",
"modified_time": "2026-10-06T08:46:20-0700",
"name": "Meeting notes",
"notebook_id": "xfalbae1b418e370f4f30bc1c8f7be6542022",
"order": 10000.0
}Update a notecard
Rename, recolour or rewrite a text notecard. Only what you fill in changes; new content replaces the old content. Zoho limits an update to about 6,000 characters of content.
Inputs
- Notecard ID
notecard_idtextRequired - The notecard's id, from 'List notecards' or an earlier step.
- New title
nametext - Optional. The notecard's new title.
- New content
contenttext - Optional. Text or HTML to replace the note's content with.
- Colour
colortext - Optional. The notecard's colour.One of:
#D9E8F0(Light blue),#FFFFFF(White),#FFF59D(Yellow),#FFB47A(Orange),#F4C2C2(Pink),#FFCDD2(Rose),#C5E1A5(Green),#B2EBF2(Cyan),#E1BEE7(Lavender),#CFD8DC(Grey).
Outputs
A notecard.
colortext- The notecard's colour, e.g. #D9E8F0.
created_bytext- The creator's Zoho account id.
created_by_user_detailsobject- A Zoho user.
created_timetext- When it was created, e.g. 2026-10-06T08:47:05-0700.
descriptiontext- The notecard's content, as HTML.
embed_resourceslist- Files embedded in the notecard, such as its image.
is_collectiontrue/false- Whether it is a collection.
is_taggedtrue/false- Whether it has any tags.
is_trashedtrue/false- Whether it is in the trash.
last_accessed_timetext- When it was last opened.
latitudenumber- Latitude it was made at.
locationtext- Where it was made; usually Unknown.
longitudenumber- Longitude it was made at.
modified_bytext- The last editor's Zoho account id.
modified_by_user_detailsobject- A Zoho user.
modified_timetext- When it last changed.
nametext- The notecard's title.
notebook_idtext- The id of the notebook it is in.
notecard_idtext- The notecard's id.
ordernumber- Its position in the notebook's custom order.
sizenumber- Its size in bytes.
typetext- The kind of notecard: note/mixed (text) or note/image.
Example output
{
"color": "#D9E8F0",
"created_by": "900000001",
"created_time": "2026-10-06T08:47:05-0700",
"description": "<div><div>Review the roadmap</div></div>",
"embed_resources": [],
"is_collection": false,
"last_accessed_time": "2026-10-06T08:47:05-0700",
"latitude": 0.0,
"location": "Unknown",
"longitude": 0.0,
"modified_by": "900000001",
"modified_time": "2026-10-06T08:47:05-0700",
"name": "Agenda",
"notebook_id": "xfalbae1b418e370f4f30bc1c8f7be6542022",
"notecard_id": "xfalbcfe652e28467469c9736ebc689540f9b",
"order": 20000.0,
"size": 455,
"type": "note/mixed"
}