WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-06 17:57:39 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
ef74da02c706f6aefbfc8b41c4e95a6d7d7ca9ab
OpenSign/assets/js/8a725248.c367aea5.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:()=>x,default:()=>b,frontMatter:()=>h,metadata:()=>u,toc:()=>f});var l=s(85893),t=s(11151),n=s(58219),i=(s(62316),s(51039)),r=s.n(i),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+tqHDcUfpUT/WkD473YSUqHUuKmIZiE2tQugdqLOTNzdka2RlIkza6XZf/1SfpofZJyNDN784UaSkrBmFnp3C/fOVqKgKUX6aV4Z3TAPHgxSURBPnfSBmm0SMVFRfDOEQaCjgiOz04AlTJzDwvTQDBA06lxQZH3agF5S61pDnknFkKFAXLUwPzowctSk/MwNY5lOJC1NS6gDlCYvKlJBz8QiTCWHLIlJ4VIRSu5EyoS4ehLQz78ZIqFSJd7hp85M5MFQUbKzMGiw5oCOTa3s3AjiL9IBxaC1iqZR53DG8+SlsLnFdXIX6xROio4ZlSjVCIRGmsSibCV0cTxCwtLIhUmu6Eo3Dr2IkjyLCFSp8ueygcndSkSMTWuxrB9QndYW8VEN4bdILFKOqXP58+I3nYHg9zULKo1+JmixodHh+Oj8dHhWKxWiQgyxOOdzFxnnJAV32/iFVxD8cBbo30bi8PR6H7e+iprRRbgmzwn76eNUosXz8nV03loj7msnhcAW42z6u7wxnII/+fJfDU+Gh/GPxbRBfw4PCRmw3Q4Ojw6GI8ORt9djN+kr75PX78ZjEaj30Ui7mq1KXFRYIhe9jXS/25s8RX0rPbJuuIsKKBUfpuhx4FVLNlXDxXluakpVFKXMCcdYO6MLhOwitATBLcALFFqUBjI/YtFSs4Z93SYnmfZds9KraSm674jr1+NRtfjdRDGj3cmKkdYLIDupA/+67r7mA1POzbecuz1fcdO9AyVLOJguzC3pL+uT9vqQ6v+fvnKlijeix1nt89bJz3ljZNhIdLLpbg7QCsP2vv0crKaJIIrxvBAtcZHizFUIhXD/fnqyc3I+SimcUqkogrB+nQ4RGsHxpLmOa4w8wxDQ7RyOGMo2af2AUupy4MnuSYbu885tm34dqxfBxGt/EiLfvamO1SJkJzTirAgFwPJKft1syq87wO/jm0PyWtEfghk1xi7MwNZ29RE07qEnFrS57LUMZ2zsdhfqD6Tyk1NvIeEiqAn/+uPPyNHv/7EansBp40Da+bkpo0C1AVMFd3JTNEDW5gnrLsdTOpApeMlp5ClDKjixsUokaPFTCrJ9clkpt2/tkrcD+BzRaGiuJp94wgQCpqR4rIGZcwtywkGsAmmjjo6m2Fu3O2UTUoAIWu81OQ9eKKehXSFOifoM52AcYAaSAdy1klPgLJmYt4MaTqVuWTBXJOO+75GjSWxsgTYbo6CbTc9D85kjQ/gjWqiI6yxJgqti5qo8AP4Wc6odZwP23FABZQNi0ggNwVBl3d2QxeQkQ9gWb3MKQr1AV0ARTNysbJjJnlDAWsYNCQqMNOd3LKg4FB7HsitQX1q1uGzzvCqE3UUuBjAlb7SDPDQeOICUFLf+vRKH8Dlusw+U+ZloMm3fbfN5/N7XfZyl+eDDFWTgSNrNnxlPIw9uc2+/vFSJCKQq/3p9JzcTObUtfgjOoeReNhBKSMKw2HXYGjl230G7iYlc9J+uzmPP5x9ghkcDUYi2cKVf2Dw8NPJu/e/nL9nuYxjbf+NB6PBKK5Mxoca9Zaq3XfOfucuNyPhP34VdSgY6C4MrUIZB0IMzbLD8su9t9IkERVjfXoplssMPf3m1GrFx18acjwoJomYoZOYMYhdTlZJj6AM/re06GYv6XBwweqZXDUtGO9NRx4ALcdxnpMNT9Juj6Oz0/MLkYise8/VpmAeh3N+6+FcpOJKXIn4LIz9HV9kfL4UCnXZYBnRPMpl4MeGY7E9NW7j1Og+2LP+Si+2rNwdJ60r/J8de5DhB07+R1r8uCZvbx5l6GLbU3MGJ6vV6m+rl2Fi",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,u={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+tqHDcUfpUT/WkD473YSUqHUuKmIZiE2tQugdqLOTNzdka2RlIkza6XZf/1SfpofZJyNDN784UaSkrBmFnp3C/fOVqKgKUX6aV4Z3TAPHgxSURBPnfSBmm0SMVFRfDOEQaCjgiOz04AlTJzDwvTQDBA06lxQZH3agF5S61pDnknFkKFAXLUwPzowctSk/MwNY5lOJC1NS6gDlCYvKlJBz8QiTCWHLIlJ4VIRSu5EyoS4ehLQz78ZIqFSJd7hp85M5MFQUbKzMGiw5oCOTa3s3AjiL9IBxaC1iqZR53DG8+SlsLnFdXIX6xROio4ZlSjVCIRGmsSibCV0cTxCwtLIhUmu6Eo3Dr2IkjyLCFSp8ueygcndSkSMTWuxrB9QndYW8VEN4bdILFKOqXP58+I3nYHg9zULKo1+JmixodHh+Oj8dHhWKxWiQgyxOOdzFxnnJAV32/iFVxD8cBbo30bi8PR6H7e+iprRRbgmzwn76eNUosXz8nV03loj7msnhcAW42z6u7wxnII/+fJfDU+Gh/GPxbRBfw4PCRmw3Q4Ojw6GI8ORt9djN+kr75PX78ZjEaj30Ui7mq1KXFRYIhe9jXS/25s8RX0rPbJuuIsKKBUfpuhx4FVLNlXDxXluakpVFKXMCcdYO6MLhOwitATBLcALFFqUBjI/YtFSs4Z93SYnmfZds9KraSm674jr1+NRtfjdRDGj3cmKkdYLIDupA/+67r7mA1POzbecuz1fcdO9AyVLOJguzC3pL+uT9vqQ6v+fvnKlijeix1nt89bJz3ljZNhIdLLpbg7QCsP2vv0crKaJIIrxvBAtcZHizFUIhXD/fnqyc3I+SimcUqkogrB+nQ4RGsHxpLmOa4w8wxDQ7RyOGMo2af2AUupy4MnuSYbu885tm34dqxfBxGt/EiLfvamO1SJkJzTirAgFwPJKft1syq87wO/jm0PyWtEfghk1xi7MwNZ29RE07qEnFrS57LUMZ2zsdhfqD6Tyk1NvIeEiqAn/+uPPyNHv/7EansBp40Da+bkpo0C1AVMFd3JTNEDW5gnrLsdTOpApeMlp5ClDKjixsUokaPFTCrJ9clkpt2/tkrcD+BzRaGiuJp94wgQCpqR4rIGZcwtywkGsAmmjjo6m2Fu3O2UTUoAIWu81OQ9eKKehXSFOifoM52AcYAaSAdy1klPgLJmYt4MaTqVuWTBXJOO+75GjSWxsgTYbo6CbTc9D85kjQ/gjWqiI6yxJgqti5qo8AP4Wc6odZwP23FABZQNi0ggNwVBl3d2QxeQkQ9gWb3MKQr1AV0ARTNysbJjJnlDAWsYNCQqMNOd3LKg4FB7HsitQX1q1uGzzvCqE3UUuBjAlb7SDPDQeOICUFLf+vRKH8Dlusw+U+ZloMm3fbfN5/N7XfZyl+eDDFWTgSNrNnxlPIw9uc2+/vFSJCKQq/3p9JzcTObUtfgjOoeReNhBKSMKw2HXYGjl230G7iYlc9J+uzmPP5x9ghkcDUYi2cKVf2Dw8NPJu/e/nL9nuYxjbf+NB6PBKK5Mxoca9Zaq3XfOfucuNyPhP34VdSgY6C4MrUIZB0IMzbLD8su9t9IkERVjfXoplssMPf3m1GrFx18acjwoJomYoZOYMYhdTlZJj6AM/re06GYv6XBwweqZXDUtGO9NRx4ALcdxnpMNT9Juj6Oz0/MLkYise8/VpmAeh3N+6+FcpOJKXIn4LIz9HV9kfL4UCnXZYBnRPMpl4MeGY7E9NW7j1Og+2LP+Si+2rNwdJ60r/J8de5DhB07+R1r8uCZvbx5l6GLbU3MGJ6vV6m+rl2Fi",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={},f=[{value:"Request",id:"request",level:2}];function g(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:"Create Contact"})}),"\n",(0,l.jsx)(r(),{method:"post",path:"/createcontact"}),"\n",(0,l.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,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})}),(0,l.jsx)("strong",{className:"openapi-schema__required",children:(0,l.jsx)(a.p,{children:"required"})})]}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to create contact"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"phone",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"1232131321"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(p.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Contact created successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.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",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,l.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,l.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,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.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,l.jsxs)(p.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)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"401",value:"401",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Contact already exists!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.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 already exists!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Contact already exists!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.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)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink