mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-28 04:24:57 +02:00
1 line
7.4 KiB
JavaScript
1 line
7.4 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9938],{90736:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>b,contentTitle:()=>y,default:()=>k,frontMatter:()=>g,metadata:()=>n,toc:()=>f});const n=JSON.parse('{"id":"API-docs/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/deletecontact.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/deletecontact","permalink":"/docs/API-docs/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":"eJzVV9tuGzcQ/ZUJXxIDa0l2nBTdp7qJkRoNGqN2EaCOYIx2R7uMuCRDcnWBsG/9kn5av6QY7q4ulm0kQBGgL7ZEznBmzgzPodYiYOFFeiveGB0wC16ME5GTz5y0QRotUnFTErwlRYGgM4Lzq0tApczCw8rUEAw4qsycACHrTKbOVLzp+pWJMbMBXE6jhzagjC7IgSbKAcGiCzKrFW7sn3uQempchZxHAqGUPgaucEYeZABCv+LYeZtcKEk6cJQZlw9EIowlF30vc5GK1qg7WyTCosOKAjmufi00ViRS0e3fyVwkQnL1FkMp7kNy5cxc5gRm8pmycJmDmW4K3yQkEuHoSy0d5SINrqZE+LBSHMbLyio2oKVVJieRTlF5NshKqlCkaxFWNloGJ3UhEtEisbtCS4ynpMKWp5PyFH0ummbMUb012pPnc05HI/63n3/fxzbRHHydZeT9tFZq9UwkEQbSgR3RWiWziOPws2fv9WGWLQ6MqmPUg2xj9/A8VM82+5+XnLv9xb4UTdL1KT8PTzudjk5fHp+Mjkc/3Jy8Ts9+TF+9HoxGoz9FIpaVYt+uozkG4nODDGr7vTkwa1u2a9itNGx89hCK16aiUEpdwIJ0gIUzukjAKkJPENwKsECpQWEg9x+iSs4Z9zQ635ZZs1O11EpquutH6O5sNLo72YBw9vgoaRNgamqdf99KHwj/dDlnd6ebcl4dlnOp56hkHonmxsxIf99ydsOHNvzhrMrWKO6LvWJ319siPWW1k2EVSW55jFYet/vp7Zi5gufEbPkxEmMoRSqGHZ8N11tObAQf6OY9adZOiVSUIVifDocedT4xy4GxpL0stMKJH2SmGqKVw/mJaJL7HmjtN1hTffxtDj5gIXXxtNd4i9E197Ft1R5Sm4ahlb/SSiR9I3atOrkoCXNysWmsXtG5a88HS/paFjo2d35yICofSWWmIhaQUBL05v/89Xf0yE1WV6RDnL1n8KF2YM2C3LRWgDqHqaKlnCh6QJw9YaXIe7UCqQMVDgNBLgsZUAGjwkyRocWJVJKnlc1Mq947A+8H8LGkUJLjreeO5T6nOSkeclDGzPicYADrYKoYo8sZFsbNppxSAgiT2ktN3oMn6l1Il6gzgr4XCRgHqIF0IGed9AQoKzaeGgc0ncpM8sE8nI4JoEKNBXGwBDhvRsG2Mu3BmUntA3ij6lgIR6yIQlsiP0H8AN7KObWF82JOAaWiHIqaj0ggMzlBd1O5DJ3DhHwAy+FlRvFQH9AFUDQnF2cvdpJlFaxhCpGo+K2w21s+KDjUnhW+TahvzQY+6wzrc4yR42oAn/QnzSQPtSceACX1zKef9DHcbsbsI028DDR+0d+HxWJxcA+O9n3eyVDWE3BkzdaviIvx1uy6b74csejuX5j9yXY0JcfVRIwK0hQnEK1sSQ5uz68uI9tCScpuI7PL4dXl1SEbDq8pBKkLP+z9j5gP+0ceU26FUrU396f750TqJFf5D9NrcnOZUccdj0A1jMZDkQglM9Kedij5/N3Ve5jDy8FIJDss9BXgDd9fvrn47fqCs2FibRE7GYwGI16yxocK9U6o/af4fRZZb8Xqf/tw79g20DIMrUIZRS6Cuu7U6VZsH/Lpzpt9nIjS+MAG6/UEPf3hVNPw8peaHIvgOBFzdBInTMm3a5FLz5/zzQv8UTRf/N495o/ga5//DxbSa4lmIZmjqvmbSMSMVvs/QJpxk/R6wqm2BudZRjbsuB68SPZk/e3F+4ubC5EIrBm4XSmbRSnrPnCABzPb17g2B/7Lcvugw3rdymTTbOzbrUc9uhp7a4Zp3DTNv2UfGnk=","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact","permalink":"/docs/API-docs/getcontact"},"next":{"title":"Get Contact list","permalink":"/docs/API-docs/contactlist"}}');var a=o(74848),c=o(28453),s=o(33617),i=o.n(s),l=o(17543),r=o.n(l),d=o(86013),p=o.n(d),m=o(63723),u=o.n(m),I=(o(18766),o(79329),o(9303));const g={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:"eJzVV9tuGzcQ/ZUJXxIDa0l2nBTdp7qJkRoNGqN2EaCOYIx2R7uMuCRDcnWBsG/9kn5av6QY7q4ulm0kQBGgL7ZEznBmzgzPodYiYOFFeiveGB0wC16ME5GTz5y0QRotUnFTErwlRYGgM4Lzq0tApczCw8rUEAw4qsycACHrTKbOVLzp+pWJMbMBXE6jhzagjC7IgSbKAcGiCzKrFW7sn3uQempchZxHAqGUPgaucEYeZABCv+LYeZtcKEk6cJQZlw9EIowlF30vc5GK1qg7WyTCosOKAjmufi00ViRS0e3fyVwkQnL1FkMp7kNy5cxc5gRm8pmycJmDmW4K3yQkEuHoSy0d5SINrqZE+LBSHMbLyio2oKVVJieRTlF5NshKqlCkaxFWNloGJ3UhEtEisbtCS4ynpMKWp5PyFH0ummbMUb012pPnc05HI/63n3/fxzbRHHydZeT9tFZq9UwkEQbSgR3RWiWziOPws2fv9WGWLQ6MqmPUg2xj9/A8VM82+5+XnLv9xb4UTdL1KT8PTzudjk5fHp+Mjkc/3Jy8Ts9+TF+9HoxGoz9FIpaVYt+uozkG4nODDGr7vTkwa1u2a9itNGx89hCK16aiUEpdwIJ0gIUzukjAKkJPENwKsECpQWEg9x+iSs4Z9zQ635ZZs1O11EpquutH6O5sNLo72YBw9vgoaRNgamqdf99KHwj/dDlnd6ebcl4dlnOp56hkHonmxsxIf99ydsOHNvzhrMrWKO6LvWJ319siPWW1k2EVSW55jFYet/vp7Zi5gufEbPkxEmMoRSqGHZ8N11tObAQf6OY9adZOiVSUIVifDocedT4xy4GxpL0stMKJH2SmGqKVw/mJaJL7HmjtN1hTffxtDj5gIXXxtNd4i9E197Ft1R5Sm4ahlb/SSiR9I3atOrkoCXNysWmsXtG5a88HS/paFjo2d35yICofSWWmIhaQUBL05v/89Xf0yE1WV6RDnL1n8KF2YM2C3LRWgDqHqaKlnCh6QJw9YaXIe7UCqQMVDgNBLgsZUAGjwkyRocWJVJKnlc1Mq947A+8H8LGkUJLjreeO5T6nOSkeclDGzPicYADrYKoYo8sZFsbNppxSAgiT2ktN3oMn6l1Il6gzgr4XCRgHqIF0IGed9AQoKzaeGgc0ncpM8sE8nI4JoEKNBXGwBDhvRsG2Mu3BmUntA3ij6lgIR6yIQlsiP0H8AN7KObWF82JOAaWiHIqaj0ggMzlBd1O5DJ3DhHwAy+FlRvFQH9AFUDQnF2cvdpJlFaxhCpGo+K2w21s+KDjUnhW+TahvzQY+6wzrc4yR42oAn/QnzSQPtSceACX1zKef9DHcbsbsI028DDR+0d+HxWJxcA+O9n3eyVDWE3BkzdaviIvx1uy6b74csejuX5j9yXY0JcfVRIwK0hQnEK1sSQ5uz68uI9tCScpuI7PL4dXl1SEbDq8pBKkLP+z9j5gP+0ceU26FUrU396f750TqJFf5D9NrcnOZUccdj0A1jMZDkQglM9Kedij5/N3Ve5jDy8FIJDss9BXgDd9fvrn47fqCs2FibRE7GYwGI16yxocK9U6o/af4fRZZb8Xqf/tw79g20DIMrUIZRS6Cuu7U6VZsH/Lpzpt9nIjS+MAG6/UEPf3hVNPw8peaHIvgOBFzdBInTMm3a5FLz5/zzQv8UTRf/N495o/ga5//DxbSa4lmIZmjqvmbSMSMVvs/QJpxk/R6wqm2BudZRjbsuB68SPZk/e3F+4ubC5EIrBm4XSmbRSnrPnCABzPb17g2B/7Lcvugw3rdymTTbOzbrUc9uhp7a4Zp3DTNv2UfGnk=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},y=void 0,b={},f=[];function h(e){const t={p:"p",...(0,c.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(I.default,{as:"h1",className:"openapi__heading",children:"Delete Contact"}),"\n",(0,a.jsx)(i(),{method:"delete",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,a.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,a.jsx)(I.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(r(),{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,a.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,a.jsx)(u(),{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 k(e={}){const{wrapper:t}={...(0,c.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(h,{...e})}):h(e)}}}]); |