Notes

The notes route returns errors differently than other routes. Errors are concentrated in a single reasons key at the root.

Search Notes

GET https://e621.net/notes.json

Query Parameters

Name	Type	Description
search[body_matches]	String	The body of the note.
search[is_active]	String	If the note is active.
search[post_id]	Number	The ID of the post the note is on. Multiple posts can be provided as a comma separated list.
search[post_tags_match]	String	The tags of the post the note is on.
search[creator_name]	String	The name of the creator of the note.
search[creator_id]	String	The ID of the creator of the note.
search[id]	Number	See Search Parameters: search[id]
limit	Number	See Search Parameters: limit
page	String	See Search Parameters: page

200: OK Success (Results)

[
  {
    "body": "",
    "created_at": "0000-00-00T00:00:00.000-00:00",
    "creator_id": 0, // user id
    "creator_name": "",
    "height": 0,
    "id": 0,
    "is_active": true,
    "post_id": 0,
    "updated_at": "0000-00-00T00:00:00.000-00:00",
    "version": 0,
    "width": 0,
    "x": 0,
    "y": 0
  }
]

200: OK Success (No Results) !!

{
  "notes": []
}

Get Note

GET https://e621.net/notes/{id}.json

Path Parameters

Name	Type	Description
id*	String	The ID of the note to get.

200: OK Success

{
  "body": "",
  "created_at": "0000-00-00T00:00:00.000-00:00",
  "creator_id": 0, // user id
  "creator_name": "",
  "height": 0,
  "id": 0,
  "is_active": true,
  "post_id": 0,
  "updated_at": "0000-00-00T00:00:00.000-00:00",
  "version": 0,
  "width": 0,
  "x": 0,
  "y": 0
}

404: Not Found Not Found

{
  "success": false,
  "reason": "not found"
}

Create Note

POST https://e621.net/notes.json

Authorization Required

Privileged+ Required If account is less than one week old.

Request Body

Name	Type	Description
note[post_id]*	String	The ID of the post to create the note on.
note[x]*	Number	The X coordinate of the note.
note[y]*	Number	The Y coordinate of the note.
note[width]*	Number	The width of the note.
note[height]*	Number	The height of the note.
note[body]*	String	The body of the note.
note[html_id]	String	A pass-through string.

200: OK Success

{
  "body": "",
  "created_at": "0000-00-00T00:00:00.000-00:00",
  "creator_id": 0, // user id
  "creator_name": "",
  "height": 0,
  "id": 0,
  "is_active": true,
  "post_id": 0,
  "updated_at": "0000-00-00T00:00:00.000-00:00",
  "version": 0,
  "width": 0,
  "x": 0,
  "y": 0,
  "html_id": null
}

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

422: Unprocessable Entity Account Too New

{
  "success": false,
  "reasons": [
    "User can not yet perform this action. Account is too new."
  ]
}

422: Unprocessable Entity Invalid Placement

// Invalid X/Y or width/height stretch outside of image.
{
  "success": false,
  "reasons": [
    "Note must be inside the image"
  ]
}

422: Unprocessable Entity Note Locked

{
  "success": false,
  "reasons": [
    "Post is note locked"
  ]
}

422: Unprocessable Entity Body Too Long

{
  "success": false,
  "reasons": [
    "Body is too long (maximum is 1000 characters)"
  ]
}

422: Unprocessable Entity Body Too Short

{
  "success": false,
  "reasons": [
    "Body is too short (minimum is 1 character)"
  ]
}

422: Unprocessable Entity Body Empty

{
  "success": false,
  "reasons": [
    "Body can't be blank"
  ]
}

422: Unprocessable Entity Invalid Post

{
  "success": false,
  "reasons": [
    "Post must exist"
  ]
}

422: Unprocessable Entity Post Not Provided

{
  "success": false,
  "reasons": [
    "Post can't be blank"
  ]
}

Edit Note

PATCH https://e621.net/notes/{id}.json

Authorization Required

Privileged+ Required If account is less than one week old.

Path Parameters

Name	Type	Description
id*	String	The ID of the note to edit.

Request Body

Name	Type	Description
note[x]	Number	The X coordinate of the note.
note[y]	Number	The Y coordinate of the note.
note[width]	Number	The width of the note.
note[height]	Number	The height of the note.
note[body]	String	The body of the note.

200: OK Success

{
  "body": "",
  "created_at": "0000-00-00T00:00:00.000-00:00",
  "creator_id": 0, // user id
  "creator_name": "",
  "height": 0,
  "id": 0,
  "is_active": true,
  "post_id": 0,
  "updated_at": "0000-00-00T00:00:00.000-00:00",
  "version": 0,
  "width": 0,
  "x": 0,
  "y": 0
}

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

404: Not Found Not Found

{
  "success": false,
  "reason": "not found"
}

422: Unprocessable Entity Account Too New

{
  "success": false,
  "reasons": [
    "User can not yet perform this action. Account is too new."
  ]
}

422: Unprocessable Entity Invalid Placement

// Invalid X/Y or width/height stretch outside of image.
{
  "success": false,
  "reasons": [
    "Note must be inside the image"
  ]
}

422: Unprocessable Entity Note Locked

{
  "success": false,
  "reasons": [
    "Post is note locked"
  ]
}

422: Unprocessable Entity Body Too Long

{
  "success": false,
  "reasons": [
    "Body is too long (maximum is 1000 characters)"
  ]
}

422: Unprocessable Entity Body Too Short

{
  "success": false,
  "reasons": [
    "Body is too short (minimum is 1 character)"
  ]
}

422: Unprocessable Entity Body Empty

{
  "success": false,
  "reasons": [
    "Body can't be blank"
  ]
}

Delete Note

DELETE https://e621.net/notes/{id}.json

Authorization Required

Privileged+ Required If account is less than one week old.

This operation is idempotent.

A success will be returned even if the note does not exist.

Deleting a note does not actually delete it, it just changes is_active to false.

Path Parameters

Name	Type	Description
id*	String	The ID of the note to edit.

Request Body

Name	Type	Description
note[x]	Number	The X coordinate of the note.
note[y]	Number	The Y coordinate of the note.
note[width]	Number	The width of the note.
note[height]	Number	The height of the note.
note[body]	String	The body of the note.

204: No Content Success

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

404: Not Found Not Found

{
  "success": false,
  "reason": "not found"
}

422: Unprocessable Entity Account Too New

{
  "success": false,
  "reasons": [
    "User can not yet perform this action. Account is too new."
  ]
}

422: Unprocessable Entity Note Locked

{
  "success": false,
  "reasons": [
    "Post is note locked"
  ]
}