mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-13 13:17:39 +02:00
1 line
7.6 KiB
JavaScript
1 line
7.6 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2661],{3347:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>f,contentTitle:()=>M,default:()=>B,frontMatter:()=>v,metadata:()=>a,toc:()=>I});const a=JSON.parse('{"id":"API-docs/v1/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","source":"@site/docs/API-docs/v1/deletecontact.api.mdx","sourceDirName":"API-docs/v1","slug":"/API-docs/v1/deletecontact","permalink":"/docs/API-docs/v1/deletecontact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar_label":"Delete Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJzVV9tu3DYQ/ZUJX3KBvLt2nBTVU93ESIwajRE7CFBnYVDirMQsRbIktRcsBPShf9A/6KflS4qhpL14bSNBiwB9sVfkXM8M55ArFnjhWXrNXhkdeB48GydMoM+dtEEazVJ2VSK8RoUBoROCk4sz4EqZuYelqSEYcFiZGQKHvBOZOFPRputXMmOmAzibRA1tQBldoAONKICD5S7IvFZ8Lf/Yg9QT4ypOcSQQSumj44pP0YMMgNwvybdogwslSgcOc+PEgCXMWHRR90ywlLVCnW2WMMsdrzCgo+xXTPMKWcq6/RspWMIkZW95KNltSC6cmUmBYLLPmIczAWayTnwdEEuYw99r6VCwNLgaE+bDUpEbLyurSAAXVhmBLJ1w5UkgL7HiLF2xsLRRMjipC5awFontFVzwaCVltjzKyiPuBWuaMXn11miPnuwcjUb0bzf+vo5toAJ8nefo/aRWavmIJREG1IEUubVK5hHH4WdP2qv9KFscCFVHqAfZ+u7huSufTfQ/Lyh2+9Y+Z03S1UmchIeVjkZHzw8ORwejH64OX6bHP6YvXg5Go9FvLGGLSpFuV1HBA5LdIIPafDd7Ym3JtgW7lYaEj+9C8dJUGEqpC5ijDjB3RhcJWIXcIwS3BF5wqUHxgO4/RBWdM+5hdL4tsmYra6mV1HjTt9DN8Wh0c7gG4fj+VtImwMTUWnzfTO9w/3A6xzdH63Re7KdzpmdcSREHzZWZov6+6Wy7D637/V6VrVDcZzvJbq+3SXrMayfDMg65xQG38qDdT6/HNCuoT8xmPsbBGEqWsmE3z4arzUxsGBl0s35o1k6xlJUhWJ8Oh55rkZnFwFjUXhZa8cwPclMNuZXD2SFrktsa3NpvkMb64NsUfOCF1MXDWuMNRpdUx7ZUO0itC8at/AWXLOkLsS3V0UWJXKCLRSP2ispded5Z1Jey0LG4s8M9UvmIKjcVEoGEEqEX//Ln31FDmLyuUIfYe48+6U/6Xe3Amjm6Sa2AawEThQuZKYzyWMW9NUN75JVC79USpA5YOB4QhCxk4AoIGhoXObc8k0pSy5KYaSl8q+v9AD6WGEp0tPXYEecLnKGiTgdeB0OErYt1vDA3bjqhu0ICHLLaS43eA+qS65wEe/gTMA64BtQBnXXSI/jgKGrZxmZ0cHTWK655gWQ72UFJoJLUm+BMVvsA3qg6hgyBS2UcCugToluHHxCIp8TADqG9qVTWYUmdMkMoainQJ5AbgeDjCaUUtIAMfQBLscgcPRmttTL5NNaNSBSsoYEhuaKbwXaMpB4c1574vI2lr8EaMOsMsTG2AT579sEjVfhc6qlPnz37pA/get1MHzHzMuD4Sd/18/l8r9uf7uq8keFtncF7tMbLYNxyo13IUNZZPCHbRtYfraU3qDH2z9YJ2NgQJvf7B45WhyUqO7zEQB3ihycXZ3HGPoUvf/wF58idhtLM227Na4dqCUXvipBrK9/Cth6RMDGx8UpCPG+bjy5e6AMhSDeC3dO8e+wcTtAR+LGQG3dWduav+zCBov83adKw7m+gxAcVl6odKz/dthPnOrrKv5tcopvJHLvBdk+Fh1F4yBKmZI7a4xZfnLy5OIcZPB+MWLI1Ir+i2sPzs1env16eUjR0slrEDgejwYiWrPGh4nrL1e474faIW22Y9H/7quioIOAiDK3iMjJwBHXVUec127wy0q0HxThhpfGBBFarjHv84FTT0PLvNTpi6HHCZtxJnhFfXK+YkJ5+i/Xz4F40n7zvXhpP4WvfJncm0hOdJpabcVXTF0vYFJe7r6Nm3CQ92VGorcBJnqMNW6p716WdO8fr0/PTq1OWMDq9uzw7jTzb/SAHd0a2S8BtDPSX7gJ3KqxWLYc3zVq+3bpXo8uxlyaYxk3T/AOnI1dC","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact","permalink":"/docs/API-docs/v1/getcontact"},"next":{"title":"Get Contact list","permalink":"/docs/API-docs/v1/contactlist"}}');var n=o(74848),c=o(28453),s=o(33617),i=o.n(s),r=o(17543),d=o.n(r),l=o(86013),p=o.n(l),h=o(63723),m=o.n(h),u=(o(18766),o(79329),o(9303));const v={id:"deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",sidebar_label:"Delete Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV9tu3DYQ/ZUJX3KBvLt2nBTVU93ESIwajRE7CFBnYVDirMQsRbIktRcsBPShf9A/6KflS4qhpL14bSNBiwB9sVfkXM8M55ArFnjhWXrNXhkdeB48GydMoM+dtEEazVJ2VSK8RoUBoROCk4sz4EqZuYelqSEYcFiZGQKHvBOZOFPRputXMmOmAzibRA1tQBldoAONKICD5S7IvFZ8Lf/Yg9QT4ypOcSQQSumj44pP0YMMgNwvybdogwslSgcOc+PEgCXMWHRR90ywlLVCnW2WMMsdrzCgo+xXTPMKWcq6/RspWMIkZW95KNltSC6cmUmBYLLPmIczAWayTnwdEEuYw99r6VCwNLgaE+bDUpEbLyurSAAXVhmBLJ1w5UkgL7HiLF2xsLRRMjipC5awFontFVzwaCVltjzKyiPuBWuaMXn11miPnuwcjUb0bzf+vo5toAJ8nefo/aRWavmIJREG1IEUubVK5hHH4WdP2qv9KFscCFVHqAfZ+u7huSufTfQ/Lyh2+9Y+Z03S1UmchIeVjkZHzw8ORwejH64OX6bHP6YvXg5Go9FvLGGLSpFuV1HBA5LdIIPafDd7Ym3JtgW7lYaEj+9C8dJUGEqpC5ijDjB3RhcJWIXcIwS3BF5wqUHxgO4/RBWdM+5hdL4tsmYra6mV1HjTt9DN8Wh0c7gG4fj+VtImwMTUWnzfTO9w/3A6xzdH63Re7KdzpmdcSREHzZWZov6+6Wy7D637/V6VrVDcZzvJbq+3SXrMayfDMg65xQG38qDdT6/HNCuoT8xmPsbBGEqWsmE3z4arzUxsGBl0s35o1k6xlJUhWJ8Oh55rkZnFwFjUXhZa8cwPclMNuZXD2SFrktsa3NpvkMb64NsUfOCF1MXDWuMNRpdUx7ZUO0itC8at/AWXLOkLsS3V0UWJXKCLRSP2ispded5Z1Jey0LG4s8M9UvmIKjcVEoGEEqEX//Ln31FDmLyuUIfYe48+6U/6Xe3Amjm6Sa2AawEThQuZKYzyWMW9NUN75JVC79USpA5YOB4QhCxk4AoIGhoXObc8k0pSy5KYaSl8q+v9AD6WGEp0tPXYEecLnKGiTgdeB0OErYt1vDA3bjqhu0ICHLLaS43eA+qS65wEe/gTMA64BtQBnXXSI/jgKGrZxmZ0cHTWK655gWQ72UFJoJLUm+BMVvsA3qg6hgyBS2UcCugToluHHxCIp8TADqG9qVTWYUmdMkMoainQJ5AbgeDjCaUUtIAMfQBLscgcPRmttTL5NNaNSBSsoYEhuaKbwXaMpB4c1574vI2lr8EaMOsMsTG2AT579sEjVfhc6qlPnz37pA/get1MHzHzMuD4Sd/18/l8r9uf7uq8keFtncF7tMbLYNxyo13IUNZZPCHbRtYfraU3qDH2z9YJ2NgQJvf7B45WhyUqO7zEQB3ihycXZ3HGPoUvf/wF58idhtLM227Na4dqCUXvipBrK9/Cth6RMDGx8UpCPG+bjy5e6AMhSDeC3dO8e+wcTtAR+LGQG3dWduav+zCBov83adKw7m+gxAcVl6odKz/dthPnOrrKv5tcopvJHLvBdk+Fh1F4yBKmZI7a4xZfnLy5OIcZPB+MWLI1Ir+i2sPzs1env16eUjR0slrEDgejwYiWrPGh4nrL1e474faIW22Y9H/7quioIOAiDK3iMjJwBHXVUec127wy0q0HxThhpfGBBFarjHv84FTT0PLvNTpi6HHCZtxJnhFfXK+YkJ5+i/Xz4F40n7zvXhpP4WvfJncm0hOdJpabcVXTF0vYFJe7r6Nm3CQ92VGorcBJnqMNW6p716WdO8fr0/PTq1OWMDq9uzw7jTzb/SAHd0a2S8BtDPSX7gJ3KqxWLYc3zVq+3bpXo8uxlyaYxk3T/AOnI1dC",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1/opensign-api-v-1",custom_edit_url:null},M=void 0,f={},I=[];function A(e){const t={p:"p",...(0,c.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Delete Contact"}),"\n",(0,n.jsx)(i(),{method:"delete",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record."}),"\n",(0,n.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(d(),{parameters:[{name:"contact_id",in:"path",description:"Provide objectId of contact to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,n.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,n.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Contact deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Contact not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact not found!"}},title:"inline_response_404_2"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function B(e={}){const{wrapper:t}={...(0,c.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(A,{...e})}):A(e)}}}]); |