1"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[7880],{43454:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>y,contentTitle:()=>f,default:()=>M,frontMatter:()=>m,metadata:()=>a,toc:()=>b});const a=JSON.parse('{"id":"api/create-or-update-a-highlight","title":"Create or update a highlight","description":"Creates a new highlight for the authenticated user, or updates an existing one matching the same offsets on the same link.","source":"@site/docs/api/create-or-update-a-highlight.api.mdx","sourceDirName":"api","slug":"/api/create-or-update-a-highlight","permalink":"/api/create-or-update-a-highlight","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"create-or-update-a-highlight","title":"Create or update a highlight","description":"Creates a new highlight for the authenticated user, or updates an existing one matching the same offsets on the same link.","sidebar_label":"Create or update a highlight","hide_title":true,"hide_table_of_contents":true,"api":"eJzFVk1v2zgQ/SvEnBnLabvAQjd3tx8pgk3QJtiD4cNYGktsKFIlKTteQf99MZRk2Y2bogts64slajjzZt6bIVvwlDVOhT2kyxbWhI7cogklpMtVt5IQsPCQLuG9KkqtijJ4WEnIyWdO1UFZAyn84QgDeYHC0E6Uo6XYWCdCSQKbUJIJKsNAuWg8OSmsE02d99uMoEflgzKFsIZEhSEr+YX3eqxI2M3GU/DCmmlNK/MwAwmOvjTkw2ub7yFt46tylEMaXEMSMmsCmcCfsK41Y1DWJJ89I2/BZyVVyE9hXxOkYNefKQuD397REjKrrQMJPqALNxEMSCCTH54DPfIfg7rKuUK1szW5oMiz897BFMUHp0wBEip8vCZTcL1/m3cMt6oGuM+Yvpi/+l2CabTGtaY+1e4U3uRAmUAFOeiOEZ/9HJP4fuTukOcZL/HH1fO1Nb7P/sV8zn+nojkISnjcUi58k2Xk/abRes+8/mfiTis/Avm+pTqbjwTW6/lcn6uD/Bbnz5P8kzhlELFp88VZGBvrKgyQAnfoRVAVxUrEhv2BLd0oh1fnFPAaczF0ryDnrPt/aR9T56KowCWGNxz142g6Qr18CvXe8AyzTv1D+a8H2UmoKJQ2hxRq66Nj5O6EBGuVbC+TcprW8jDhPzGsPvLxnD/ELkOo2TyaQToYgRwe3o4Ef/j7LgLkdD9O0/fNI1a1pqNxN4njoPhp6UTY8xMdz0fZTtZjo/GMVGZjn1J0rczDDl1ORtzUZBa3V+JPmzUcNrLD4tqS87315Ww+m8NUZDa/MsHZvMmiQw6Z0UCOwViQd3/di8VmQ86Kd2TIoRa3zVqrTFz3tmL7MnptnB7q6dMk2e12s8I0M+uKZHDqEyxqffFyNp+VodKxnMxkheYoXn+uTkelwOlwha8O4XYS5a89jwcxMYFJrVGZODm4IO2g0iVgrZiNS5BQntwrSlZzuoS2XaOne6e7jpe/NOT4grKSsEWn+gG5XHUSSsKcXLy7PNCec++rcHHHMNhcNwznSZt2ctyxyDKqw7O2q6OGu735dMc9Mdw3KpvzHoc7vjPgDlIACTay0jc5r7Wg0RQNFmzb+2TK8bQBv2q4mNXwCc3+CGHb9hZ39oFM14EcUgn8Dt2q67p/AYnIZuA=","sidebar_class_name":"post api-method","info_path":"api/api-introduction","custom_edit_url":null,"hide_send_button":true},"sidebar":"sidebar","previous":{"title":"Update dashboard layout (v2)","permalink":"/api/update-dashboard-layout-v-2"},"next":{"title":"Delete a highlight","permalink":"/api/delete-a-highlight"}}');var n=i(74848),s=i(28453),r=i(57742),o=i.n(r),p=i(78178),h=i.n(p),d=i(19624),l=i.n(d),c=i(96226),g=i.n(c),u=(i(77675),i(19365),i(51107));const m={id:"create-or-update-a-highlight",title:"Create or update a highlight",description:"Creates a new highlight for the authenticated user, or updates an existing one matching the same offsets on the same link.",sidebar_label:"Create or update a highlight",hide_title:!0,hide_table_of_contents:!0,api:"eJzFVk1v2zgQ/SvEnBnLabvAQjd3tx8pgk3QJtiD4cNYGktsKFIlKTteQf99MZRk2Y2bogts64slajjzZt6bIVvwlDVOhT2kyxbWhI7cogklpMtVt5IQsPCQLuG9KkqtijJ4WEnIyWdO1UFZAyn84QgDeYHC0E6Uo6XYWCdCSQKbUJIJKsNAuWg8OSmsE02d99uMoEflgzKFsIZEhSEr+YX3eqxI2M3GU/DCmmlNK/MwAwmOvjTkw2ub7yFt46tylEMaXEMSMmsCmcCfsK41Y1DWJJ89I2/BZyVVyE9hXxOkYNefKQuD397REjKrrQMJPqALNxEMSCCTH54DPfIfg7rKuUK1szW5oMiz897BFMUHp0wBEip8vCZTcL1/m3cMt6oGuM+Yvpi/+l2CabTGtaY+1e4U3uRAmUAFOeiOEZ/9HJP4fuTukOcZL/HH1fO1Nb7P/sV8zn+nojkISnjcUi58k2Xk/abRes+8/mfiTis/Avm+pTqbjwTW6/lcn6uD/Bbnz5P8kzhlELFp88VZGBvrKgyQAnfoRVAVxUrEhv2BLd0oh1fnFPAaczF0ryDnrPt/aR9T56KowCWGNxz142g6Qr18CvXe8AyzTv1D+a8H2UmoKJQ2hxRq66Nj5O6EBGuVbC+TcprW8jDhPzGsPvLxnD/ELkOo2TyaQToYgRwe3o4Ef/j7LgLkdD9O0/fNI1a1pqNxN4njoPhp6UTY8xMdz0fZTtZjo/GMVGZjn1J0rczDDl1ORtzUZBa3V+JPmzUcNrLD4tqS87315Ww+m8NUZDa/MsHZvMmiQw6Z0UCOwViQd3/di8VmQ86Kd2TIoRa3zVqrTFz3tmL7MnptnB7q6dMk2e12s8I0M+uKZHDqEyxqffFyNp+VodKxnMxkheYoXn+uTkelwOlwha8O4XYS5a89jwcxMYFJrVGZODm4IO2g0iVgrZiNS5BQntwrSlZzuoS2XaOne6e7jpe/NOT4grKSsEWn+gG5XHUSSsKcXLy7PNCec++rcHHHMNhcNwznSZt2ctyxyDKqw7O2q6OGu735dMc9Mdw3KpvzHoc7vjPgDlIACTay0jc5r7Wg0RQNFmzb+2TK8bQBv2q4mNXwCc3+CGHb9hZ39oFM14EcUgn8Dt2q67p/AYnIZuA=",sidebar_class_name:"post api-method",info_path:"api/api-introduction",custom_edit_url:null,hide_send_button:!0},f=void 0,y={},b=[];function j(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Create or update a highlight"}),"\n",(0,n.jsx)(o(),{method:"post",path:"/api/v1/highlights",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"Creates a new highlight for the authenticated user, or updates an existing one matching the same offsets on the same link."}),"\n",(0,n.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(h(),{parameters:void 0}),"\n",(0,n.jsx)(l(),{title:"Body",body:{required:!0,content:{"application/json":{schema:{type:"object",required:["color","startOffset","endOffset","text","linkId"],properties:{color:{type:"string",maxLength:50}
1,comment:{type:"string",maxLength:2048,nullable:!0},startOffset:{type:"integer"},endOffset:{type:"integer"},text:{type:"string",maxLength:2048},linkId:{type:"integer"}}}}}}}),"\n",(0,n.jsx)(g(),{id:void 0,label:void 0,responses:{200:{description:"Highlight saved successfully.",content:{"application/json":{schema:{type:"object",properties:{response:{type:"object",properties:{id:{type:"integer"},userId:{type:"integer"},linkId:{type:"integer"},color:{type:"string"},comment:{type:"string",nullable:!0},startOffset:{type:"integer"},endOffset:{type:"integer"},text:{type:"string"},createdAt:{type:"string",format:"date-time"},updatedAt:{type:"string",format:"date-time"}}}}}}}},400:{description:"Bad request error.",content:{"application/json":{schema:{type:"object",properties:{response:{type:"string"}},title:"ErrorResponse"}}}},401:{description:"Unauthorized",content:{"application/json":{schema:{type:"object",properties:{response:{type:"string"}},title:"ErrorResponse"}}}}}})]})}function M(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(j,{...e})}):j(e)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.