Files
OpenSign/assets/js/8a725248.ace1ce06.js
T

1 line
11 KiB
JavaScript

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7971],{80288:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>j,default:()=>b,frontMatter:()=>x,metadata:()=>u,toc:()=>f});var t=s(85893),i=s(11151),l=s(58219),n=(s(62316),s(51039)),r=s.n(n),c=(s(82723),s(9487)),o=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const x={id:"createcontact",title:"Create contact",description:"Create contact",sidebar_label:"Create contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV21rG0cQ/ivb+RTDSbqTlJQepcQNJpiE2EQuhcrCrO5G0tp3u5vdPb0g7r+X2XvRSXLcGkqgYIw0OzM788wzM6s9OL60EE/hg5KOJ87CLACl0XAnlLxOIYbEIHeYVOcQgOaG5+jQkN0eJM8RYtj2uBY9p55QQgBCQgwr5CkaCMDgt0IYTCF2psAArNtlZGNFrjOEAHCrM5UixAueWVJIVphziPfgdtprOiPkEkpS5d4opiilFUvZ3263Wyhn1T1o3e8q3ZFtijYxQlMiEIM2ai1SZHPM1Ia1STCnWJUhO6RIn1A6csK1zkTi0Rg8WvK074R3yGwKVzkXGQTwhQAJ4HalJBKadQpq/ogVfobwdQItefDaZ4kGsFAm564rOWT+qCgNJDiqS19vP0d8Xwv6icrJVRXwK11Fw9EwGkWjYQRlGYATzouPOPMwp4KUdH7MBC+wWklbYTEMw/O61cSsi5QyWyQJWrsosmz302tq9XIdKjER/nUA6FU0X22Hj5og/J8XcxyNoqH/Ixc14JfuOTcHo2E4HPWisBf+fBe9i8e/xG/f9cMw/AsC2OY+m3pCpNz5LBuONN8Lnf6Ae8pTtZqcKTouMts1aOZA6Sk7DsfnpJyoHN1KyCXboHRsY5RcBkxnyC0yZ3aML7mQLOMOzX9IUjRGmZdhel1k3Z4VMhMSH5qOfBiH44eoBeHtOQjXcs0zkbLL22t2R4P/x2bavd5V159XWVRK1V46SrYrr5K0mBRGuJ1fa919Fk9ntF5O5tLp0iDcFS1MrWy1J90KYhic7k+LZt0sz8JktCid0zYeDKzjSyGXPa51v9luGZ9bauoB12KwjvyeawKdEJgVXkfhtqhxLT7hDoJ/XtKUP9Xo62GFXjVIN0uqHVXtpHpu+LSz52g30G0L5UOrK3CjUU7EUvr6rSM4xfduJSwT1h+nKilylM5ziS2UYSfWbM4tpkxJ5lboD0k+6kfMakzEoqZhn93Le0ktwgqLiyJjmZBPNr6XPTa9WSxEInjG/sS5FQ5nb5q6bDabs3pceJuPwq2KOTOo1UF96YW+aF2r9ssFBODQ5PZmMUGzFgnWHPjOVQOvPKibi0hEDVJXoBa9PzUiyDORoLTYaYfLj7ef2agfQtCh3r8IefD5+sPVl8kVeSXyViWK+mE/JBExPueyc9FZdxwVtyWow60b6IwL35w+pH3dONOTh+csgBU1VjyF/Z7K/YfJypLE3wo01LSzANbcCD4nfk1nZdCQmzotFZYO0vaNeRJQO7fgzdf6kXLBIHg+0CfcnXXTmmcFaUIZ7GuFD5XP3h35OGiczcWDxWWSoHYv6s46k+b2ZnIHAczrB2/u39Bg+IYe3XwDMdzDPQC96MmDnxRevoeMy2XBl76tvV+aALwg5Lvj48mPj/oD4dgcyV0nymMkqlToPyX2rMGv1J6fcPdbq16dfNeg/S1RaVMZZmVZ/g1rnE9A",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,u={id:"API-docs/createcontact",title:"Create contact",description:"Create contact",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:"Create contact",sidebar_label:"Create contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV21rG0cQ/ivb+RTDSbqTlJQepcQNJpiE2EQuhcrCrO5G0tp3u5vdPb0g7r+X2XvRSXLcGkqgYIw0OzM788wzM6s9OL60EE/hg5KOJ87CLACl0XAnlLxOIYbEIHeYVOcQgOaG5+jQkN0eJM8RYtj2uBY9p55QQgBCQgwr5CkaCMDgt0IYTCF2psAArNtlZGNFrjOEAHCrM5UixAueWVJIVphziPfgdtprOiPkEkpS5d4opiilFUvZ3263Wyhn1T1o3e8q3ZFtijYxQlMiEIM2ai1SZHPM1Ia1STCnWJUhO6RIn1A6csK1zkTi0Rg8WvK074R3yGwKVzkXGQTwhQAJ4HalJBKadQpq/ogVfobwdQItefDaZ4kGsFAm564rOWT+qCgNJDiqS19vP0d8Xwv6icrJVRXwK11Fw9EwGkWjYQRlGYATzouPOPMwp4KUdH7MBC+wWklbYTEMw/O61cSsi5QyWyQJWrsosmz302tq9XIdKjER/nUA6FU0X22Hj5og/J8XcxyNoqH/Ixc14JfuOTcHo2E4HPWisBf+fBe9i8e/xG/f9cMw/AsC2OY+m3pCpNz5LBuONN8Lnf6Ae8pTtZqcKTouMts1aOZA6Sk7DsfnpJyoHN1KyCXboHRsY5RcBkxnyC0yZ3aML7mQLOMOzX9IUjRGmZdhel1k3Z4VMhMSH5qOfBiH44eoBeHtOQjXcs0zkbLL22t2R4P/x2bavd5V159XWVRK1V46SrYrr5K0mBRGuJ1fa919Fk9ntF5O5tLp0iDcFS1MrWy1J90KYhic7k+LZt0sz8JktCid0zYeDKzjSyGXPa51v9luGZ9bauoB12KwjvyeawKdEJgVXkfhtqhxLT7hDoJ/XtKUP9Xo62GFXjVIN0uqHVXtpHpu+LSz52g30G0L5UOrK3CjUU7EUvr6rSM4xfduJSwT1h+nKilylM5ziS2UYSfWbM4tpkxJ5lboD0k+6kfMakzEoqZhn93Le0ktwgqLiyJjmZBPNr6XPTa9WSxEInjG/sS5FQ5nb5q6bDabs3pceJuPwq2KOTOo1UF96YW+aF2r9ssFBODQ5PZmMUGzFgnWHPjOVQOvPKibi0hEDVJXoBa9PzUiyDORoLTYaYfLj7ef2agfQtCh3r8IefD5+sPVl8kVeSXyViWK+mE/JBExPueyc9FZdxwVtyWow60b6IwL35w+pH3dONOTh+csgBU1VjyF/Z7K/YfJypLE3wo01LSzANbcCD4nfk1nZdCQmzotFZYO0vaNeRJQO7fgzdf6kXLBIHg+0CfcnXXTmmcFaUIZ7GuFD5XP3h35OGiczcWDxWWSoHYv6s46k+b2ZnIHAczrB2/u39Bg+IYe3XwDMdzDPQC96MmDnxRevoeMy2XBl76tvV+aALwg5Lvj48mPj/oD4dgcyV0nymMkqlToPyX2rMGv1J6fcPdbq16dfNeg/S1RaVMZZmVZ/g1rnE9A",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"}},g={},f=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,i.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)(r(),{method:"post",path:"/createcontact"}),"\n",(0,t.jsx)(a.p,{children:"Create contact"}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(h.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)(l.Z,{children:[(0,t.jsxs)(h.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)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.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)(h.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)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.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)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(y,{...e})}):y(e)}}}]);