WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-10 03:37:40 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
fda95286f00a9425ce8ecacff55c4be1156769a8
OpenSign/assets/js/8a725248.350b9d87.js
T

1 line
11 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:()=>x,contentTitle:()=>u,default:()=>y,frontMatter:()=>h,metadata:()=>j,toc:()=>f});var t=s(85893),r=s(11151),l=s(58219),n=(s(62316),s(51039)),i=s.n(n),c=(s(82723),s(9487)),o=(s(41429),s(5397)),d=s(4667),m=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:"eJzVVm1r40YQ/ivb+dQD2ZZs35WKUi4N4Qh3XEKdUqhjwloaW5usdvd2V3aM0X8vs5Ic2ckdDZQrhRDk2Xl9npnZ3YPnawfpHM618jzzDhYR5OgyK4wXWkEKNwWyc4vcI8saJXZ2fcm4lHrr2E5XzGuGq5W2XqJzcseyRlvhtrNwzBfcs4wrRvbcMSfWCq1jK23Jh2WiNNp6rjzLdVaVqLwbQgTaoOWUyWUOKTSeW6cQgcUvFTr/m853kO5PEr+2eiNyZEuUessMt7xEj5bSzY7qgQjoC5UnJ9wYKbIQc3TvyNMeXFZgyemLIgqLOWF2UXIhIYLPvESI4LrQCgk/vzMIKejlPQbnxlIVXqAjD0E73Xdazluh1hDBStuS+74EH3lpJCndayoDoY7aoK+3XyK+bwXDTJfkqkn4la6S8WScTJLJOIG6jsALH8RHzNwtiZCazp/w8rbCIHBGK9dgMY7j57y1rdiSlDNXZRk6t6qk3P3wGq6+zUMjprZ6HQCmSJbF4/jeEIT/czKnySQZhz9y0QJ+5l9y82Q0jseTQRIP4p9uknfp9Of07bthHMd/QQSPZahGBVQg5z5U2fVI97sy+XeIU5+qtc2Zo+dCur5Btwfq0LLTePq8KWe6RF8ItWZbVJ5trVbriBmJ3CHzdsf4mgvFJPdo/8UmRWu1/TZMr8usP7NCSaHwrpvIu2k8vUsOILx9DsKl2nAp8rD/b/QDqu9baT+8b8I/Z1k0SuEcjorty5siHWaVFX4H6XwPjwNuxKA5T+eLehEBAavp3jHahYy5LyCF0ek15NBu0LrgprISUii8Ny4djZzna6HWA27MUBtUdO1JvnQ0tSNuxGiTAEXqMpkRWg0gR/kcYOFGfMQdRF25fa0IBLFUIM/RBmiIhN+f7siLDsruFjrsosMqemm7HJbL0fKnaCsdUmshvjKoZmKtAkGbBJ6/JIRjwoXj7pIPzRJeASfWbMkd5kwr5gsMhySfDBPmDGZi1fbZkN2qW0UzwCqHq0oyKdSDS2/VgM2vViuRCS7Zn7h0wuPix46X7Xb7jI83weaD8EW1ZBaNflJfB2EgrW91+PEGIvBoS3e1mqHdiAzbHvhKqFFQHrXTQ01EE9Ay0IrenxoR5FJkqBz2+v3sw/UnNhnGEPVa7x+kPPp0eX7xeXZBXql5G4qSYTyMSUQdX3LVC3R++mY6Inf/tAf+4xdjOygeH/3ISC7CFgjQ7NsBnp+8IxcRFDTg6Rz2e2q7P6ysaxJ/qdDSdlhEsOFW8CX1+XxRR92Q0cQ/4K59taDygxsKT+qyaub1ZCXWUWdxlmVo/Dd1+zvo+mp2AxEs27duqXOysXxL72C+hRRu4RbCk5k8hB0S5HuQXK0rvg4DH/zSbuAVYdFfLA9hsbQfVFl3pHa9LI83TlMK/afCXjT4hcj/iLtfD+rNyVcNWmw7bWJwUdf139bFTx0=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={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:"eJzVVm1r40YQ/ivb+dQD2ZZs35WKUi4N4Qh3XEKdUqhjwloaW5usdvd2V3aM0X8vs5Ic2ckdDZQrhRDk2Xl9npnZ3YPnawfpHM618jzzDhYR5OgyK4wXWkEKNwWyc4vcI8saJXZ2fcm4lHrr2E5XzGuGq5W2XqJzcseyRlvhtrNwzBfcs4wrRvbcMSfWCq1jK23Jh2WiNNp6rjzLdVaVqLwbQgTaoOWUyWUOKTSeW6cQgcUvFTr/m853kO5PEr+2eiNyZEuUessMt7xEj5bSzY7qgQjoC5UnJ9wYKbIQc3TvyNMeXFZgyemLIgqLOWF2UXIhIYLPvESI4LrQCgk/vzMIKejlPQbnxlIVXqAjD0E73Xdazluh1hDBStuS+74EH3lpJCndayoDoY7aoK+3XyK+bwXDTJfkqkn4la6S8WScTJLJOIG6jsALH8RHzNwtiZCazp/w8rbCIHBGK9dgMY7j57y1rdiSlDNXZRk6t6qk3P3wGq6+zUMjprZ6HQCmSJbF4/jeEIT/czKnySQZhz9y0QJ+5l9y82Q0jseTQRIP4p9uknfp9Of07bthHMd/QQSPZahGBVQg5z5U2fVI97sy+XeIU5+qtc2Zo+dCur5Btwfq0LLTePq8KWe6RF8ItWZbVJ5trVbriBmJ3CHzdsf4mgvFJPdo/8UmRWu1/TZMr8usP7NCSaHwrpvIu2k8vUsOILx9DsKl2nAp8rD/b/QDqu9baT+8b8I/Z1k0SuEcjorty5siHWaVFX4H6XwPjwNuxKA5T+eLehEBAavp3jHahYy5LyCF0ek15NBu0LrgprISUii8Ny4djZzna6HWA27MUBtUdO1JvnQ0tSNuxGiTAEXqMpkRWg0gR/kcYOFGfMQdRF25fa0IBLFUIM/RBmiIhN+f7siLDsruFjrsosMqemm7HJbL0fKnaCsdUmshvjKoZmKtAkGbBJ6/JIRjwoXj7pIPzRJeASfWbMkd5kwr5gsMhySfDBPmDGZi1fbZkN2qW0UzwCqHq0oyKdSDS2/VgM2vViuRCS7Zn7h0wuPix46X7Xb7jI83weaD8EW1ZBaNflJfB2EgrW91+PEGIvBoS3e1mqHdiAzbHvhKqFFQHrXTQ01EE9Ay0IrenxoR5FJkqBz2+v3sw/UnNhnGEPVa7x+kPPp0eX7xeXZBXql5G4qSYTyMSUQdX3LVC3R++mY6Inf/tAf+4xdjOygeH/3ISC7CFgjQ7NsBnp+8IxcRFDTg6Rz2e2q7P6ysaxJ/qdDSdlhEsOFW8CX1+XxRR92Q0cQ/4K59taDygxsKT+qyaub1ZCXWUWdxlmVo/Dd1+zvo+mp2AxEs27duqXOysXxL72C+hRRu4RbCk5k8hB0S5HuQXK0rvg4DH/zSbuAVYdFfLA9hsbQfVFl3pHa9LI83TlMK/afCXjT4hcj/iLtfD+rNyVcNWmw7bWJwUdf139bFTx0=",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 details",permalink:"/docs/API-docs/get-user"},next:{title:"Get contact",permalink:"/docs/API-docs/getcontact"}},x={},f=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,r.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)(d.Z,{collapsible:!1,name:"Name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(d.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)(l.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)(m.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)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(d.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)(d.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:"404",value:"404",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)(m.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)(d.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:"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)(m.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)(d.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,r.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink