WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-29 21:14:59 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
c65d3cecf43fccd545a5b2ccc8cb44c46318e4d5
OpenSign/assets/js/7b076186.496e8402.js
T

1 line
9.6 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8489],{91945:(e,a,t)=>{t.r(a),t.d(a,{assets:()=>x,contentTitle:()=>j,default:()=>v,frontMatter:()=>u,metadata:()=>f,toc:()=>b});var s=t(85893),l=t(11151),n=t(58219),c=(t(62316),t(51039)),o=t.n(c),i=(t(82723),t(9487)),r=t(41429),d=t(5397),m=t(4667),p=t(9472),h=t(85162);const u={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:"eJzVVm1v2zYQ/ivcfVkDyJbspB0mDMOyNuiMBkuwZBgwxwho6WSxpkiWpBwbhv77cJRsy3FS9MMwYF9s6fgc7+65N23B84WDdArvtfI88w5mEeToMiuMF1pBCvclsg8o0SPrQOzydsK4lPrJsY2umdfMYqVXyDjLOkhhdUWHdieZa70cskkRNJRmUqsFWqYQc8aZ4daLrJZ8j//eMaEKbStOfkTMl8IFwxVfomPCM+RuQ7bz1jlforDMYqZtPoQItEEbdCc5pNCCurshAsMtr9Cjpei3oHiFkEJ3/ihyiEBQ9Ib7Ep5Tcmv1SuTI9PwzZn6SM13sA987BBFY/FILizmk3tYYgfMbSWacqIwkAK6N1DlCWnDpCJCVWHFIt+A3JiC9FWoBEbRM9CW45uGWFEw5npdj7nJomhlZdUYrh47uGScJ/R37v8tj62jOXJ1l6FxRS7n5DqJAAypPitwYKbLAY/zZkfb21MuWB2LVEutetLZ39LwUz8H7X9fku/nNnEMTdXnKL/3XlcbJ+HwwSgbJD/ejd+nFj+nbd8MkSf6GCNaVJN0uozn3SPd64eXhvTmBtSnrAztJQ+CL5OJ1FpX2rNC1yv9F6tBabb9OwQvmm57/Qkmh8HFXDI8XycXjeB/O29NwJmrFpchDj93rJar/Npy+ed+aP02TaEHhHI6C7cvbIB1mtRV+E/p7PeBGDNrzdDqjNqnQl/owGsJM8CWkEHetHG8P46AButCudvOithJSKL03Lo1j5/lCqMWAGzPUBpUTCyX53A0zXcXciHg1AjK5c+mOaGuZOXJszw834hNuINrF3Ud1g6lEnqMNHNGcDModGzcG1Z1YqMDlanQyvu5plHbTNNdZXaHyIa+s0JY902Zz7jBnWtGADYckPx+OmDOYiaIriSF7UA/qTlfIaodFLZkUaunSBzVg05uiEJngkv2Fcyc8zt7smHt6ejph7CzofBS+rOfMotEH+CIIA619rf3LGUTg0VbuprhDuxIZdll6xVQcwHFX6LQZqFgrLuRhGfzyXIkKT4oMlcNeaV5+vL1m58MEol5xfIPL8fXk/dXvd1d0K5VXm6LRMBkmJDLa+YqrnqFuFx9W2VFyt4eW/d9u7q4JPK59bCQXodUDqduuR6dwCD/tLe1ZBKV2ngDbLRXun1Y2DYm/1GhpFMwiWHEr+Jw6ZbqFXDh6zvcr+FU23/zRbfMz9q37/8VAdi2uqL9XXNb0BhEscXP8BdLMmmjX5uRqC7jMMjS+p3oyl4+G24er66v7K4iA10Rcf8Isw4TpHsjAi54dj57WB/ptolcUfqJUf8LNz3t4e/KqQhfiDk0szZqm+QcbN6Km",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,f={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:"eJzVVm1v2zYQ/ivcfVkDyJbspB0mDMOyNuiMBkuwZBgwxwho6WSxpkiWpBwbhv77cJRsy3FS9MMwYF9s6fgc7+65N23B84WDdArvtfI88w5mEeToMiuMF1pBCvclsg8o0SPrQOzydsK4lPrJsY2umdfMYqVXyDjLOkhhdUWHdieZa70cskkRNJRmUqsFWqYQc8aZ4daLrJZ8j//eMaEKbStOfkTMl8IFwxVfomPCM+RuQ7bz1jlforDMYqZtPoQItEEbdCc5pNCCurshAsMtr9Cjpei3oHiFkEJ3/ihyiEBQ9Ib7Ep5Tcmv1SuTI9PwzZn6SM13sA987BBFY/FILizmk3tYYgfMbSWacqIwkAK6N1DlCWnDpCJCVWHFIt+A3JiC9FWoBEbRM9CW45uGWFEw5npdj7nJomhlZdUYrh47uGScJ/R37v8tj62jOXJ1l6FxRS7n5DqJAAypPitwYKbLAY/zZkfb21MuWB2LVEutetLZ39LwUz8H7X9fku/nNnEMTdXnKL/3XlcbJ+HwwSgbJD/ejd+nFj+nbd8MkSf6GCNaVJN0uozn3SPd64eXhvTmBtSnrAztJQ+CL5OJ1FpX2rNC1yv9F6tBabb9OwQvmm57/Qkmh8HFXDI8XycXjeB/O29NwJmrFpchDj93rJar/Npy+ed+aP02TaEHhHI6C7cvbIB1mtRV+E/p7PeBGDNrzdDqjNqnQl/owGsJM8CWkEHetHG8P46AButCudvOithJSKL03Lo1j5/lCqMWAGzPUBpUTCyX53A0zXcXciHg1AjK5c+mOaGuZOXJszw834hNuINrF3Ud1g6lEnqMNHNGcDModGzcG1Z1YqMDlanQyvu5plHbTNNdZXaHyIa+s0JY902Zz7jBnWtGADYckPx+OmDOYiaIriSF7UA/qTlfIaodFLZkUaunSBzVg05uiEJngkv2Fcyc8zt7smHt6ejph7CzofBS+rOfMotEH+CIIA619rf3LGUTg0VbuprhDuxIZdll6xVQcwHFX6LQZqFgrLuRhGfzyXIkKT4oMlcNeaV5+vL1m58MEol5xfIPL8fXk/dXvd1d0K5VXm6LRMBkmJDLa+YqrnqFuFx9W2VFyt4eW/d9u7q4JPK59bCQXodUDqduuR6dwCD/tLe1ZBKV2ngDbLRXun1Y2DYm/1GhpFMwiWHEr+Jw6ZbqFXDh6zvcr+FU23/zRbfMz9q37/8VAdi2uqL9XXNb0BhEscXP8BdLMmmjX5uRqC7jMMjS+p3oyl4+G24er66v7K4iA10Rcf8Isw4TpHsjAi54dj57WB/ptolcUfqJUf8LNz3t4e/KqQhfiDk0szZqm+QcbN6Km",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"}},x={},b=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:t}=a;return t||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,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("h1",{className:"openapi__heading",children:(0,s.jsx)(a.p,{children:"Delete contact"})}),"\n",(0,s.jsx)(o(),{method:"delete",path:"/contact/{contact_id}"}),"\n",(0,s.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,s.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,s.jsxs)(t,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(a.p,{children:"Path Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.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,s.jsx)("div",{children:(0,s.jsx)("div",{children:(0,s.jsxs)(n.Z,{children:[(0,s.jsxs)(h.default,{label:"200",value:"200",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Contact deleted successfully!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(i.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(t,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,s.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,s.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,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(d.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(h.default,{label:"404",value:"404",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Contact not found!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(i.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(t,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,s.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(d.Z,{responseExample:'{\n "error": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(h.default,{label:"405",value:"405",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Invalid API Token!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(i.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(t,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,s.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,s.jsx)(a,{...e,children:(0,s.jsx)(y,{...e})}):y(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink