Files
OpenSign/assets/js/7b076186.fc1c0045.js
T

1 line
12 KiB
JavaScript

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8489],{91945:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>v,frontMatter:()=>j,metadata:()=>x,toc:()=>g});var l=s(85893),t=s(11151),n=s(58219),o=(s(62316),s(51039)),c=s.n(o),i=(s(82723),s(9487)),r=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const j={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:"eJzVVttu20YQ/ZXJviQBaEl2nBQliqJuYqRGjCaoXQSoIxgjckRutNzd7A4lC4Le+iX9tH5JMSQlUb4hBYoAfbHF3bmenTkzK8VYRJVeqdfOMmYc1ThROcUsaM/aWZWqy5LgDRligk4ITj6cARrjFhGWrgZ2EKhycwKErBOZBlfJZdicTJybDeBs2mhYB8bZggJYohwQPAbWWW1wK/80grZTFyqUOBLgUsfGcYUziqAZCONSfOdtcFySDhAocyEfqEQ5T6HRPctVqlqhzrZKlMeAFTEFyX6lLFakUtXdX+tcJUpL9h65VLch+RDcXOcEbvKZMj7LwU23iW8DUokK9KXWgXKVcqgpUZGXRtxEXXkjAnTjjctJpVM0UQSykipU6Urx0jeSHLQtVKJaJPondIONlVT58mhSHmHM1Xo9Fq/ROxspip2j0Uj+7ce/ecc20BxinWUU47Q2ZvlEJQ0MZFkU0XujswbH4eco2qu7UbY4CKpBUGfd+t7Ac18+u+h/vpHY/S/+hVon3TvlJ/y40tHo6MXB4ehg9N3l4av0+Pv05avBaDT6QyXqpjKi271ojkxilzWb3ff6jlj7ZH3B7mQtwsf3oXjhKuJS2wIWZBkWwdkiAW8IIwGHJWCB2oJBpvAfokohuPA4Ov8usnUva22NtnS9KaHr49Ho+nALwvHDpWQdw9TVNv+2md7j/vF0jq+Ptum8vJvOmZ2j0XlDNJduRvbbptN3z637u7WqW6HmXu0l2z9vk4yU1UHzsiG5mwP0+qC9T6/GwhVSJ27Hjw0xcqlSNez4bLjaceJaicEw35BmHYxKVcnsYzocovcD58lGXViDkzjIXDVEr4fzQ7VObktHxkLb4uBRrfEugQsBucVxL40tmuj1O1qqZINSX6rj8pIwp9AgKqOlUe6we+/JXujCNsjPD+8w/kcymatI2J1Lgo3433/+1WjkLqsrstwUxhN4XwfwbkFhWhtAm8PU0I2eGLpnckbCylCMZgnaMhUBmSDXhWY0IKhIG2focaKNllISMdeO1l41xgF8LIlLCnL1NMgszmlORioQjHMzscMOsGZXNT66mGHhwmwqISWAMKmjthQjRKKNCtkSbUaweYsEXAC0QJYp+KAjAepKhKcuAE2nOtNiWConSHdWaLEgcZaAxC0o+HaGRghuUkeG6EzdJCIeKyJuU5T9IA7gjZ5Tm7gc5sSoDeVQ1GIigczlBF0bSRo2hwlFBi/udUaN0cgYGAzNKTS117ykzDzwTvpbo5FB3n9bMcQBbZTx2wa0eZotfD44GZ6NjxyXA/hkP1lhYKgjSQEYbWcx/WQP4GpbZh9pEjXT+NmmHxaLxZ0+eL6v81ZzWU8gkHc7vaI5bLqmr779eK4SxRSq+H56QWGuM+qa8AGfw0Z42LGe7ErCXBVq0/bYT7cVhIGMzshG6nHUydsP5zCHF4ORSnqd/xUBD8/PXp/+enEqdoVp2v47HIwGIznyLnKFtudqfze93bmrHXv/bzfZjuGYbnjoDeqG9RtQVx1dX6ndZpv2lthxokoXWQRWqwlG+j2Y9VqOv9QUZCqMEzXHoHEiNHi1UrmO8jvfrqQPovnst267fQ5fuw/fm8iGv62Q9xxNLV8qUTNa7m/k6/E62XC4hNoKnGQZee6p3hnRe3Puzen56eWpShTWAlx/fMya8dH9EAf3RrY/V9oY5K+MuHsVfpCnfkfLH7fi7c2DCl2KG2lBabxer/8BxCfDgQ==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={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:!1,unlisted:!1,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:!0,hide_table_of_contents:!0,api:"eJzVVttu20YQ/ZXJviQBaEl2nBQliqJuYqRGjCaoXQSoIxgjckRutNzd7A4lC4Le+iX9tH5JMSQlUb4hBYoAfbHF3bmenTkzK8VYRJVeqdfOMmYc1ThROcUsaM/aWZWqy5LgDRligk4ITj6cARrjFhGWrgZ2EKhycwKErBOZBlfJZdicTJybDeBs2mhYB8bZggJYohwQPAbWWW1wK/80grZTFyqUOBLgUsfGcYUziqAZCONSfOdtcFySDhAocyEfqEQ5T6HRPctVqlqhzrZKlMeAFTEFyX6lLFakUtXdX+tcJUpL9h65VLch+RDcXOcEbvKZMj7LwU23iW8DUokK9KXWgXKVcqgpUZGXRtxEXXkjAnTjjctJpVM0UQSykipU6Urx0jeSHLQtVKJaJPondIONlVT58mhSHmHM1Xo9Fq/ROxspip2j0Uj+7ce/ecc20BxinWUU47Q2ZvlEJQ0MZFkU0XujswbH4eco2qu7UbY4CKpBUGfd+t7Ac18+u+h/vpHY/S/+hVon3TvlJ/y40tHo6MXB4ehg9N3l4av0+Pv05avBaDT6QyXqpjKi271ojkxilzWb3ff6jlj7ZH3B7mQtwsf3oXjhKuJS2wIWZBkWwdkiAW8IIwGHJWCB2oJBpvAfokohuPA4Ov8usnUva22NtnS9KaHr49Ho+nALwvHDpWQdw9TVNv+2md7j/vF0jq+Ptum8vJvOmZ2j0XlDNJduRvbbptN3z637u7WqW6HmXu0l2z9vk4yU1UHzsiG5mwP0+qC9T6/GwhVSJ27Hjw0xcqlSNez4bLjaceJaicEw35BmHYxKVcnsYzocovcD58lGXViDkzjIXDVEr4fzQ7VObktHxkLb4uBRrfEugQsBucVxL40tmuj1O1qqZINSX6rj8pIwp9AgKqOlUe6we+/JXujCNsjPD+8w/kcymatI2J1Lgo3433/+1WjkLqsrstwUxhN4XwfwbkFhWhtAm8PU0I2eGLpnckbCylCMZgnaMhUBmSDXhWY0IKhIG2focaKNllISMdeO1l41xgF8LIlLCnL1NMgszmlORioQjHMzscMOsGZXNT66mGHhwmwqISWAMKmjthQjRKKNCtkSbUaweYsEXAC0QJYp+KAjAepKhKcuAE2nOtNiWConSHdWaLEgcZaAxC0o+HaGRghuUkeG6EzdJCIeKyJuU5T9IA7gjZ5Tm7gc5sSoDeVQ1GIigczlBF0bSRo2hwlFBi/udUaN0cgYGAzNKTS117ykzDzwTvpbo5FB3n9bMcQBbZTx2wa0eZotfD44GZ6NjxyXA/hkP1lhYKgjSQEYbWcx/WQP4GpbZh9pEjXT+NmmHxaLxZ0+eL6v81ZzWU8gkHc7vaI5bLqmr779eK4SxRSq+H56QWGuM+qa8AGfw0Z42LGe7ErCXBVq0/bYT7cVhIGMzshG6nHUydsP5zCHF4ORSnqd/xUBD8/PXp/+enEqdoVp2v47HIwGIznyLnKFtudqfze93bmrHXv/bzfZjuGYbnjoDeqG9RtQVx1dX6ndZpv2lthxokoXWQRWqwlG+j2Y9VqOv9QUZCqMEzXHoHEiNHi1UrmO8jvfrqQPovnst267fQ5fuw/fm8iGv62Q9xxNLV8qUTNa7m/k6/E62XC4hNoKnGQZee6p3hnRe3Puzen56eWpShTWAlx/fMya8dH9EAf3RrY/V9oY5K+MuHsVfpCnfkfLH7fi7c2DCl2KG2lBabxer/8BxCfDgQ==",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"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Delete Contact"})}),"\n",(0,l.jsx)(c(),{method:"delete",path:"/contact/{contact_id}"}),"\n",(0,l.jsx)(a.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,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(r.Z,{className:"paramsItem",param:{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,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Contact deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(i.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(i.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Contact not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(i.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(i.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]);