WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-28 20:44:56 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
51bf413d746aeae00543f6439e9ee9cbda22d65d
OpenSign/assets/js/8a725248.6792c484.js
T

1 line
13 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7971],{80288:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var t=s(85893),l=s(11151),n=s(58219),r=(s(62316),s(51039)),i=s.n(r),c=(s(82723),s(9487)),o=(s(41429),s(5397)),m=s(4667),d=s(9472),p=s(85162);const h={id:"createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV+lqHEcQfpVy/0kMo71kO2QIwYpjjLCJRKRgiLSImpna2ZZ6utvdPXuw7L88SR4tTxKqZ2YvHUQQHAJCzHbXfXxVvRIBSy/SK/HO6IB58GKciIJ87qQN0miRisspwTtHGAhaIjg5PwVUysw9LE0NwQBNJsYFRd6rJeQNtaY55K1YCFMMkKMG5kcPXpaanIeJcSzDgayscQF1gMLkdUU6+J5IhLHkkC05LUQqGsmtUJEIR19q8uEnUyxFujow/NyZmSwIMlJmDhYdVhTIsbmthVtB/EU6sBC0Vsk86uzfepa0Ej6fUoX8xRqlo4JjRhVKJRKhsSKRCDs1mjh+YWlJpMJktxSFW8deBEmeJUTqdNVR+eCkLkUiJsZVGHZPaIGVVUx0a9gNEuukVfp8/ozobXvQy03FohqDnylqODoeDY+Hx6OhWK8TEWSIx3uZuck4IWu+38YruJrigbdG+yYWo8Hgft66KmtEFuDrPCfvJ7VSyxfPydXTeWiOuayeFwA7HWbTxejWcgj/58l8NTwejuIfi2gDfhIeErNlGg1Gx0fDwdHgu8vhm/TV9+nrN73BYPC7SMSiUtsSFwWG6GVXI93v2hZfQc/6kKwtzoICSuV3GTocWMeSffVQUV6YisJU6hLmpAPMndFlAlYReoLgloAlSg0KA7l/sUjJOeOeDtPzLNvtWamV1HTTdeTNq8HgZrgJwvDxzkTlCIsl0EL64L+uu4/Z8LRjwx3HXt937FTPUMkiDrZLc0f66/q0qz406u+Xr2yI4r3Yc3b3vHHSU147GZYivVqJxRFaedTcp1fj9TgRXDGGB6o1PlqMYSpS0T+cr57cjJyPYmqnRCqmIVif9vsedZGZRc9Y0jzLFWaeoaiPVvZnDCeHHGjtM6h9wFLq8uhJrvHW0wvORhPwPX83YUcrP9Kym9bpHlUiJFfBlLAgF0PPSf51u1y871K1yUYH4hsMfwiWN6i8NzVZ28RE09oUnlnSF7LUsQBmQ3G4gn0mlZuKeHMJU4KO/K8//owc3cIU6/MFnNUOrJmTm9QKUBcwUbSQmaIH9jZPWLVbm9SBSsdrUSFLGVDFHY1xJUeLmVSSK5rJTLOx7TSF78HnKYUpxWXuG0eAUNCMFDcCKGPuWE4wgHUwVdTR2gxz4+4mbFICCFntpSbvwRN1LKSnqHOCLtMJGAeogXQgZ530BCgrJuZdkiYTmUsWzFXsGCkq1FgSK0uA7eYo2GY39OBMVvsA3qg6OsIaK6LQuKiJCt+Dn+WMGsf5sBkgVEBZs4gEclMQtHlnN3QBGfkAltXLnKJQH9AFUDQjFys7ZpJ3GrCGYUaiAjPZyy0LCg615xHeGNSlZhM+6wwvR1FHgcseXOtrzSMBak9cAErqO59e6yO42pTZZ8q8DDT+tuu2+Xx+r8te7vN8kGFaZ+DImi1fGQ9jT+6yb368FIkI5Cp/NrkgN5M5tS3+iM5+JO634MsYxADaNhha+faQgbtJyZy0323Okw/nn2AGx72BSHZw5R8Y3P90+u79LxfvWS4jX9N/w96gN4hLlvGhQr2jav9ldNi5q+0Q+Y/fUS0KBlqEvlUo4wiJoVm16H918LoaJ2LK0yG9EqtVhp5+c2q95uMvNTkeLeNEzNBJzBjErsbrpENQHhd3tGynNelwdMnqmVzVDRgfzFMeAA3HSZ6TDU/S7g6w87OLS5GIrH0BVqZgHodzfh3iXKTiWlyL+JCM/R3fcHy+Egp1WWMZ0TzKZeDHmmOxOzXu4tRoP9iz7kovd6zcHyeNK/yfHXuQ4QdO/kda/rghb24eZWhj21FzBsfr9fpvroJzNA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",source:"@site/docs/API-docs/createcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createcontact",permalink:"/docs/API-docs/createcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV+lqHEcQfpVy/0kMo71kO2QIwYpjjLCJRKRgiLSImpna2ZZ6utvdPXuw7L88SR4tTxKqZ2YvHUQQHAJCzHbXfXxVvRIBSy/SK/HO6IB58GKciIJ87qQN0miRisspwTtHGAhaIjg5PwVUysw9LE0NwQBNJsYFRd6rJeQNtaY55K1YCFMMkKMG5kcPXpaanIeJcSzDgayscQF1gMLkdUU6+J5IhLHkkC05LUQqGsmtUJEIR19q8uEnUyxFujow/NyZmSwIMlJmDhYdVhTIsbmthVtB/EU6sBC0Vsk86uzfepa0Ej6fUoX8xRqlo4JjRhVKJRKhsSKRCDs1mjh+YWlJpMJktxSFW8deBEmeJUTqdNVR+eCkLkUiJsZVGHZPaIGVVUx0a9gNEuukVfp8/ozobXvQy03FohqDnylqODoeDY+Hx6OhWK8TEWSIx3uZuck4IWu+38YruJrigbdG+yYWo8Hgft66KmtEFuDrPCfvJ7VSyxfPydXTeWiOuayeFwA7HWbTxejWcgj/58l8NTwejuIfi2gDfhIeErNlGg1Gx0fDwdHgu8vhm/TV9+nrN73BYPC7SMSiUtsSFwWG6GVXI93v2hZfQc/6kKwtzoICSuV3GTocWMeSffVQUV6YisJU6hLmpAPMndFlAlYReoLgloAlSg0KA7l/sUjJOeOeDtPzLNvtWamV1HTTdeTNq8HgZrgJwvDxzkTlCIsl0EL64L+uu4/Z8LRjwx3HXt937FTPUMkiDrZLc0f66/q0qz406u+Xr2yI4r3Yc3b3vHHSU147GZYivVqJxRFaedTcp1fj9TgRXDGGB6o1PlqMYSpS0T+cr57cjJyPYmqnRCqmIVif9vsedZGZRc9Y0jzLFWaeoaiPVvZnDCeHHGjtM6h9wFLq8uhJrvHW0wvORhPwPX83YUcrP9Kym9bpHlUiJFfBlLAgF0PPSf51u1y871K1yUYH4hsMfwiWN6i8NzVZ28RE09oUnlnSF7LUsQBmQ3G4gn0mlZuKeHMJU4KO/K8//owc3cIU6/MFnNUOrJmTm9QKUBcwUbSQmaIH9jZPWLVbm9SBSsdrUSFLGVDFHY1xJUeLmVSSK5rJTLOx7TSF78HnKYUpxWXuG0eAUNCMFDcCKGPuWE4wgHUwVdTR2gxz4+4mbFICCFntpSbvwRN1LKSnqHOCLtMJGAeogXQgZ530BCgrJuZdkiYTmUsWzFXsGCkq1FgSK0uA7eYo2GY39OBMVvsA3qg6OsIaK6LQuKiJCt+Dn+WMGsf5sBkgVEBZs4gEclMQtHlnN3QBGfkAltXLnKJQH9AFUDQjFys7ZpJ3GrCGYUaiAjPZyy0LCg615xHeGNSlZhM+6wwvR1FHgcseXOtrzSMBak9cAErqO59e6yO42pTZZ8q8DDT+tuu2+Xx+r8te7vN8kGFaZ+DImi1fGQ9jT+6yb368FIkI5Cp/NrkgN5M5tS3+iM5+JO634MsYxADaNhha+faQgbtJyZy0323Okw/nn2AGx72BSHZw5R8Y3P90+u79LxfvWS4jX9N/w96gN4hLlvGhQr2jav9ldNi5q+0Q+Y/fUS0KBlqEvlUo4wiJoVm16H918LoaJ2LK0yG9EqtVhp5+c2q95uMvNTkeLeNEzNBJzBjErsbrpENQHhd3tGynNelwdMnqmVzVDRgfzFMeAA3HSZ6TDU/S7g6w87OLS5GIrH0BVqZgHodzfh3iXKTiWlyL+JCM/R3fcHy+Egp1WWMZ0TzKZeDHmmOxOzXu4tRoP9iz7kovd6zcHyeNK/yfHXuQ4QdO/kda/rghb24eZWhj21FzBsfr9fpvroJzNA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get your account details",permalink:"/docs/API-docs/get-user"},next:{title:"Get Contact",permalink:"/docs/API-docs/getcontact"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const a={h2:"h2",p:"p",...(0,l.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,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Create Contact"})}),"\n",(0,t.jsx)(i(),{method:"post",path:"/createcontact"}),"\n",(0,t.jsx)(a.p,{children:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(a.p,{children:"Body"})}),(0,t.jsx)("strong",{className:"openapi-schema__required",children:(0,t.jsx)(a.p,{children:"required"})})]}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,t.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,t.jsx)(a.p,{children:"Provide below parameter to create contact"})})}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"phone",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"1232131321"}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(n.Z,{children:[(0,t.jsxs)(p.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.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,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"401",value:"401",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact already exists!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact already exists!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "error": "Contact already exists!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink