{"openapi":"3.0.2","paths":{"/api/v1/documents":{"get":{"description":"This endpoint is deprecated, but will continue to be supported. For more details, see https://docs.documenso.com/developers/public-api.","summary":"Get all documents","deprecated":true,"tags":[],"parameters":[{"name":"authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","schema":{"default":1,"type":"number","minimum":1}},{"name":"perPage","in":"query","schema":{"default":10,"type":"number","minimum":1}}],"operationId":"getDocuments","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"documents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"externalId":{"type":"string","nullable":true},"userId":{"type":"number"},"teamId":{"type":"number","nullable":true},"title":{"type":"string"},"status":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","format":"date-time","nullable":true}},"required":["id","userId","title","status","createdAt","updatedAt","completedAt"]}},"totalPages":{"type":"number"}},"required":["documents","totalPages"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}}},"post":{"description":"This endpoint is deprecated, but will continue to be supported. For more details, see https://docs.documenso.com/developers/public-api.","summary":"Upload a new document and get a presigned URL","deprecated":true,"tags":[],"parameters":[{"name":"authorization","in":"header","required":true,"schema":{"type":"string"}}],"operationId":"createDocument","requestBody":{"description":"Body","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1},"externalId":{"type":"string","nullable":true},"folderId":{"type":"string","description":"The ID of the folder to create the document in. If not provided, the document will be created in the root folder."},"recipients":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"email":{"type":"string","format":"email","minLength":1},"role":{"default":"SIGNER","type":"string","enum":["CC","SIGNER","VIEWER","APPROVER","ASSISTANT"]},"signingOrder":{"type":"number","nullable":true}},"required":["name","email"]}},"meta":{"default":{},"type":"object","properties":{"subject":{"type":"string"},"message":{"type":"string"},"timezone":{"default":"Etc/UTC","type":"string","description":"The timezone of the date. Must be one of the options listed in the list below.","enum":["Etc/UTC","Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Costa_Rica","America/Coyhaique","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Fort_Nelson","America/Fortaleza","America/Glace_Bay","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Inuvik","America/Iqaluit","America/Jamaica","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montserrat","America/Nassau","America/New_York","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Whitehorse","America/Winnipeg","America/Yakutat","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Chita","Asia/Colombo","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kathmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Riyadh","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ulaanbaatar","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faroe","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/Perth","Australia/Sydney","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kirov","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Ulyanovsk","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zurich","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Wake","Pacific/Wallis"]},"dateFormat":{"default":"yyyy-MM-dd hh:mm a","type":"string","description":"The format of the date. Must be one of the options listed in the list below.","enum":["yyyy-MM-dd hh:mm a","yyyy-MM-dd HH:mm","dd/MM/yyyy HH:mm","dd/MM/yyyy hh:mm a","MM/dd/yyyy HH:mm","MM/dd/yyyy hh:mm a","dd.MM.yyyy HH:mm","yy-MM-dd HH:mm","yy-MM-dd hh:mm a","yyyy-MM-dd HH:mm:ss","MMMM dd, yyyy HH:mm","MMMM dd, yyyy hh:mm a","EEEE, MMMM dd, yyyy HH:mm","EEEE, MMMM dd, yyyy hh:mm a","yyyy-MM-dd'T'HH:mm:ss.SSSXXX","yyyy-MM-dd","dd/MM/yyyy","MM/dd/yyyy","dd.MM.yyyy","yy-MM-dd","MMMM dd, yyyy","EEEE, MMMM dd, yyyy"]},"redirectUrl":{"type":"string"},"signingOrder":{"type":"string","enum":["PARALLEL","SEQUENTIAL"]},"allowDictateNextSigner":{"type":"boolean"},"language":{"type":"string","enum":["de","en","fr","es","it","nl","pl","pt-BR","ja","ko","zh"]},"typedSignatureEnabled":{"default":true,"type":"boolean"},"uploadSignatureEnabled":{"default":true,"type":"boolean"},"drawSignatureEnabled":{"default":true,"type":"boolean"},"distributionMethod":{"type":"string","enum":["EMAIL","NONE"]},"emailSettings":{"nullable":true}}},"authOptions":{"type":"object","properties":{"globalAccessAuth":{"default":[],"oneOf":[{"type":"string","enum":["ACCOUNT","TWO_FACTOR_AUTH"],"description":"The type of authentication required for the recipient to access the document."},{"type":"array","items":{"type":"string","enum":["ACCOUNT","TWO_FACTOR_AUTH"],"description":"The type of authentication required for the recipient to access the document."}}]},"globalActionAuth":{"default":[],"oneOf":[{"type":"string","enum":["ACCOUNT","PASSKEY","TWO_FACTOR_AUTH","PASSWORD"],"description":"The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only."},{"type":"array","items":{"type":"string","enum":["ACCOUNT","PASSKEY","TWO_FACTOR_AUTH","PASSWORD"],"description":"The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only."}}]}},"description":"The globalActionAuth property is only available for Enterprise accounts."},"formValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"number"}]}},"attachments":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1},"data":{"type":"string","format":"uri"},"type":{"default":"link","type":"string","enum":["link"]}},"required":["label","data"]}}},"required":["title","recipients"]}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"uploadUrl":{"type":"string","minLength":1},"documentId":{"type":"number"},"externalId":{"type":"string","nullable":true},"recipients":{"type":"array","items":{"type":"object","properties":{"recipientId":{"type":"number"},"name":{"type":"string"},"email":{"type":"string","format":"email","minLength":1},"token":{"type":"string"},"role":{"type":"string","enum":["CC","SIGNER","VIEWER","APPROVER","ASSISTANT"]},"signingOrder":{"type":"number","nullable":true},"signingUrl":{"type":"string"}},"required":["recipientId","name","email","token","role","signingUrl"]}}},"required":["uploadUrl","documentId","recipients"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}}}},"/api/v1/documents/{id}":{"get":{"description":"This endpoint is deprecated, but will continue to be supported. For more details, see https://docs.documenso.com/developers/public-api.","summary":"Get a single document","deprecated":true,"tags":[],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","required":true,"schema":{"type":"string"}}],"operationId":"getDocument","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"externalId":{"type":"string","nullable":true},"userId":{"type":"number"},"teamId":{"type":"number","nullable":true},"title":{"type":"string"},"status":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","format":"date-time","nullable":true},"recipients":{},"fields":{}},"required":["id","userId","title","status","createdAt","updatedAt","completedAt","recipients","fields"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}}},"delete":{"description":"This endpoint is deprecated, but will continue to be supported. For more details, see https://docs.documenso.com/developers/public-api.","summary":"Delete a document","deprecated":true,"tags":[],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","required":true,"schema":{"type":"string"}}],"operationId":"deleteDocument","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"externalId":{"type":"string","nullable":true},"userId":{"type":"number"},"teamId":{"type":"number","nullable":true},"title":{"type":"string"},"status":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","format":"date-time","nullable":true}},"required":["id","userId","title","status","createdAt","updatedAt","completedAt"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}}}},"/api/v1/documents/{id}/download":{"get":{"description":"This endpoint is deprecated, but will continue to be supported. For more details, see https://docs.documenso.com/developers/public-api.","summary":"Download a signed document when the storage transport is S3","deprecated":true,"tags":[],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"downloadOriginalDocument","in":"query","schema":{"default":false,"type":"boolean","nullable":true}}],"operationId":"downloadSignedDocument","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"downloadUrl":{"type":"string"}},"required":["downloadUrl"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}}}},"/api/v1/templates":{"post":{"description":"This endpoint is deprecated, but will continue to be supported. For more details, see https://docs.documenso.com/developers/public-api.","summary":"Create a new template and get a presigned URL","deprecated":true,"tags":[],"parameters":[{"name":"authorization","in":"header","required":true,"schema":{"type":"string"}}],"operationId":"createTemplate","requestBody":{"description":"Body","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":255,"description":"The title of the document."},"folderId":{"type":"string"},"externalId":{"type":"string","nullable":true},"visibility":{"type":"string","enum":["EVERYONE","MANAGER_AND_ABOVE","ADMIN"]},"globalAccessAuth":{"default":[],"type":"array","items":{"type":"string","enum":["ACCOUNT","TWO_FACTOR_AUTH"],"description":"The type of authentication required for the recipient to access the document."}},"globalActionAuth":{"default":[],"type":"array","items":{"type":"string","enum":["ACCOUNT","PASSKEY","TWO_FACTOR_AUTH","PASSWORD"],"description":"The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only."}},"publicTitle":{"type":"string","minLength":1,"maxLength":50,"description":"The title of the template that will be displayed to the public. Only applicable for public templates."},"publicDescription":{"type":"string","minLength":1,"maxLength":256,"description":"The description of the template that will be displayed to the public. Only applicable for public templates."},"type":{"type":"string","enum":["PUBLIC","PRIVATE"]},"meta":{"type":"object","properties":{"subject":{"type":"string","maxLength":254,"description":"The subject of the email that will be sent to the recipients."},"message":{"type":"string","maxLength":5000,"description":"The message of the email that will be sent to the recipients."},"timezone":{"type":"string","description":"The timezone to use for date fields and signing the document. Example Etc/UTC, Australia/Melbourne"},"dateFormat":{"type":"string","enum":["yyyy-MM-dd hh:mm a","yyyy-MM-dd","dd/MM/yyyy","MM/dd/yyyy","yy-MM-dd","MMMM dd, yyyy","EEEE, MMMM dd, yyyy","dd/MM/yyyy hh:mm a","dd/MM/yyyy HH:mm","MM/dd/yyyy hh:mm a","MM/dd/yyyy HH:mm","dd.MM.yyyy","dd.MM.yyyy HH:mm","yyyy-MM-dd HH:mm","yy-MM-dd hh:mm a","yy-MM-dd HH:mm","yyyy-MM-dd HH:mm:ss","MMMM dd, yyyy hh:mm a","MMMM dd, yyyy HH:mm","EEEE, MMMM dd, yyyy hh:mm a","EEEE, MMMM dd, yyyy HH:mm","yyyy-MM-dd'T'HH:mm:ss.SSSXXX"],"description":"The date format to use for date fields and signing the document."},"distributionMethod":{"type":"string","enum":["EMAIL","NONE"],"description":"The distribution method to use when sending the document to the recipients."},"emailId":{"type":"string","nullable":true},"emailReplyTo":{"type":"string","format":"email","nullable":true},"emailSettings":{"nullable":true},"redirectUrl":{"type":"string","description":"The URL to which the recipient should be redirected after signing the document."},"language":{"type":"string","enum":["de","en","fr","es","it","nl","pl","pt-BR","ja","ko","zh"],"description":"The language to use for email communications with recipients."},"typedSignatureEnabled":{"type":"boolean","description":"Whether to allow recipients to sign using a typed signature."},"uploadSignatureEnabled":{"type":"boolean","description":"Whether to allow recipients to sign using an uploaded signature."},"drawSignatureEnabled":{"type":"boolean","description":"Whether to allow recipients to sign using a draw signature."},"signingOrder":{"type":"string","enum":["PARALLEL","SEQUENTIAL"]},"allowDictateNextSigner":{"type":"boolean"}}},"attachments":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1},"data":{"type":"string","format":"uri"},"type":{"default":"link","type":"string","enum":["link"]}},"required":["label","data"]}}},"required":["title"]}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"template":{"type":"object","properties":{"type":{"type":"string","enum":["PUBLIC","PRIVATE"]},"visibility":{"type":"string","enum":["EVERYONE","MANAGER_AND_ABOVE","ADMIN"]},"id":{"type":"number"},"externalId":{"type":"string","nullable":true},"title":{"type":"string"},"userId":{"type":"number"},"teamId":{"type":"number"},"authOptions":{"type":"object","properties":{"globalAccessAuth":{"type":"array","items":{"type":"string","enum":["ACCOUNT","TWO_FACTOR_AUTH"],"description":"The type of authentication required for the recipient to access the document."}},"globalActionAuth":{"type":"array","items":{"type":"string","enum":["ACCOUNT","PASSKEY","TWO_FACTOR_AUTH","PASSWORD"],"description":"The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only."}}},"required":["globalAccessAuth","globalActionAuth"],"nullable":true},"createdAt":{"type":"string","format":"date-time","nullable":true},"updatedAt":{"type":"string","format":"date-time","nullable":true},"publicTitle":{"type":"string"},"publicDescription":{"type":"string"},"folderId":{"type":"string","nullable":true},"envelopeId":{"type":"string"},"templateDocumentDataId":{"default":"","type":"string"},"templateDocumentData":{"type":"object","properties":{"type":{"type":"string","enum":["S3_PATH","BYTES","BYTES_64"]},"id":{"type":"string"},"data":{"type":"string"},"initialData":{"type":"string"},"envelopeItemId":{"type":"string"}},"required":["type","id","data","initialData","envelopeItemId"]},"templateMeta":{"type":"object","properties":{"id":{"type":"string"},"subject":{"type":"string","nullable":true},"message":{"type":"string","nullable":true},"timezone":{"type":"string","nullable":true},"dateFormat":{"type":"string","nullable":true},"signingOrder":{"type":"string","enum":["PARALLEL","SEQUENTIAL"]},"typedSignatureEnabled":{"type":"boolean"},"uploadSignatureEnabled":{"type":"boolean"},"drawSignatureEnabled":{"type":"boolean"},"allowDictateNextSigner":{"type":"boolean"},"distributionMethod":{"type":"string","enum":["EMAIL","NONE"]},"redirectUrl":{"type":"string","nullable":true},"language":{"type":"string"},"emailSettings":{"nullable":true},"emailId":{"type":"string","nullable":true},"emailReplyTo":{"type":"string","nullable":true},"templateId":{"type":"number","nullable":true}},"required":["id","subject","message","timezone","dateFormat","signingOrder","typedSignatureEnabled","uploadSignatureEnabled","drawSignatureEnabled","allowDictateNextSigner","distributionMethod","redirectUrl","language","emailId","emailReplyTo","templateId"]},"directLink":{"type":"object","properties":{"id":{"type":"string"},"envelopeId":{"type":"string"},"token":{"type":"string"},"createdAt":{"type":"string","format":"date-time","nullable":true},"enabled":{"type":"boolean"},"directTemplateRecipientId":{"type":"number"},"templateId":{"type":"number"}},"required":["id","envelopeId","token","createdAt","enabled","directTemplateRecipientId","templateId"],"nullable":true},"user":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string","nullable":true},"email":{"type":"string"}},"required":["id","name","email"]},"recipients":{"type":"array","items":{"type":"object","properties":{"envelopeId":{"type":"string"},"role":{"type":"string","enum":["CC","SIGNER","VIEWER","APPROVER","ASSISTANT"]},"readStatus":{"type":"string","enum":["NOT_OPENED","OPENED"]},"signingStatus":{"type":"string","enum":["NOT_SIGNED","SIGNED","REJECTED"]},"sendStatus":{"type":"string","enum":["NOT_SENT","SENT"]},"id":{"type":"number"},"email":{"type":"string"},"name":{"type":"string"},"token":{"type":"string"},"documentDeletedAt":{"type":"string","format":"date-time","nullable":true},"expired":{"type":"string","format":"date-time","nullable":true},"signedAt":{"type":"string","format":"date-time","nullable":true},"authOptions":{"type":"object","properties":{"accessAuth":{"type":"array","items":{"type":"string","enum":["ACCOUNT","TWO_FACTOR_AUTH"],"description":"The type of authentication required for the recipient to access the document."}},"actionAuth":{"type":"array","items":{"type":"string","enum":["ACCOUNT","PASSKEY","TWO_FACTOR_AUTH","PASSWORD","EXPLICIT_NONE"],"description":"The type of authentication required for the recipient to sign the document."}}},"required":["accessAuth","actionAuth"],"nullable":true},"signingOrder":{"type":"number","description":"The order in which the recipient should sign the document. Only works if the document is set to sequential signing.","nullable":true},"rejectionReason":{"type":"string","nullable":true},"documentId":{"type":"number","nullable":true},"templateId":{"type":"number","nullable":true}},"required":["envelopeId","role","readStatus","signingStatus","sendStatus","id","email","name","token","documentDeletedAt","expired","signedAt","signingOrder","rejectionReason"]}},"fields":{"type":"array","items":{"type":"object","properties":{"envelopeId":{"type":"string"},"envelopeItemId":{"type":"string"},"type":{"type":"string","enum":["SIGNATURE","FREE_SIGNATURE","INITIALS","NAME","EMAIL","DATE","TEXT","NUMBER","RADIO","CHECKBOX","DROPDOWN"]},"id":{"type":"number"},"secondaryId":{"type":"string"},"recipientId":{"type":"number"},"page":{"type":"number","description":"The page number of the field on the document. Starts from 1."},"positionX":{"nullable":true},"positionY":{"nullable":true},"width":{"nullable":true},"height":{"nullable":true},"customText":{"type":"string"},"inserted":{"type":"boolean"},"fieldMeta":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["signature"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["initials"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["name"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["email"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["date"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"characterLimit":{"type":"number","minimum":0,"nullable":true},"textAlign":{"type":"string","enum":["left","center","right"]},"lineHeight":{"type":"number","minimum":1,"maximum":10,"description":"The line height of the text","nullable":true},"letterSpacing":{"type":"number","minimum":0,"maximum":100,"description":"The spacing between each character","nullable":true},"verticalAlign":{"type":"string","enum":["top","middle","bottom"],"description":"The vertical alignment of the text","nullable":true}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["number"]},"numberFormat":{"type":"string","nullable":true},"value":{"type":"string"},"minValue":{"type":"number","nullable":true},"maxValue":{"type":"number","nullable":true},"textAlign":{"type":"string","enum":["left","center","right"]},"lineHeight":{"type":"number","minimum":1,"maximum":10,"description":"The line height of the text","nullable":true},"letterSpacing":{"type":"number","minimum":0,"maximum":100,"description":"The spacing between each character","nullable":true},"verticalAlign":{"type":"string","enum":["top","middle","bottom"],"description":"The vertical alignment of the text","nullable":true}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["radio"]},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"checked":{"type":"boolean"},"value":{"type":"string"}},"required":["id","checked","value"]}},"direction":{"default":"vertical","type":"string","enum":["vertical","horizontal"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["checkbox"]},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"checked":{"type":"boolean"},"value":{"type":"string"}},"required":["id","checked","value"]}},"validationRule":{"type":"string"},"validationLength":{"type":"number"},"direction":{"default":"vertical","type":"string","enum":["vertical","horizontal"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["dropdown"]},"values":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"]}},"defaultValue":{"type":"string"}},"required":["type"]}],"nullable":true},"documentId":{"type":"number","nullable":true},"templateId":{"type":"number","nullable":true}},"required":["envelopeId","envelopeItemId","type","id","secondaryId","recipientId","page","positionX","positionY","width","height","customText","inserted","fieldMeta"]}},"folder":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["DOCUMENT","TEMPLATE"]},"visibility":{"type":"string","enum":["EVERYONE","MANAGER_AND_ABOVE","ADMIN"]},"userId":{"type":"number"},"teamId":{"type":"number"},"pinned":{"type":"boolean"},"parentId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time","nullable":true},"updatedAt":{"type":"string","format":"date-time","nullable":true}},"required":["id","name","type","visibility","userId","teamId","pinned","parentId","createdAt","updatedAt"],"nullable":true},"envelopeItems":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"envelopeId":{"type":"string"}},"required":["id","envelopeId"]}}},"required":["type","visibility","id","externalId","title","userId","teamId","createdAt","updatedAt","publicTitle","publicDescription","folderId","envelopeId","templateDocumentData","templateMeta","directLink","user","recipients","fields","folder","envelopeItems"]},"uploadUrl":{"type":"string","minLength":1}},"required":["template","uploadUrl"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}}},"get":{"description":"This endpoint is deprecated, but will continue to be supported. For more details, see https://docs.documenso.com/developers/public-api.","summary":"Get all templates","deprecated":true,"tags":[],"parameters":[{"name":"authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","schema":{"default":1,"type":"number","minimum":1}},{"name":"perPage","in":"query","schema":{"default":10,"type":"number","minimum":1}}],"operationId":"getTemplates","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"templates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"externalId":{"type":"string","nullable":true},"type":{"type":"string","enum":["PUBLIC","PRIVATE"]},"title":{"type":"string"},"userId":{"type":"number"},"teamId":{"type":"number","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"directLink":{"type":"object","properties":{"token":{"type":"string"},"enabled":{"type":"boolean"}},"required":["token","enabled"],"nullable":true},"Field":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"documentId":{"type":"number","nullable":true},"templateId":{"type":"number","nullable":true},"recipientId":{"type":"number"},"type":{"type":"string","enum":["SIGNATURE","FREE_SIGNATURE","INITIALS","NAME","EMAIL","DATE","TEXT","NUMBER","RADIO","CHECKBOX","DROPDOWN"]},"page":{"type":"number"},"positionX":{"nullable":true},"positionY":{"nullable":true},"width":{"nullable":true},"height":{"nullable":true},"customText":{"type":"string"},"fieldMeta":{"oneOf":[{"type":"object","properties":{},"additionalProperties":false},{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["signature"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["initials"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["name"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["email"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["date"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"characterLimit":{"type":"number","minimum":0,"nullable":true},"textAlign":{"type":"string","enum":["left","center","right"]},"lineHeight":{"type":"number","minimum":1,"maximum":10,"description":"The line height of the text","nullable":true},"letterSpacing":{"type":"number","minimum":0,"maximum":100,"description":"The spacing between each character","nullable":true},"verticalAlign":{"type":"string","enum":["top","middle","bottom"],"description":"The vertical alignment of the text","nullable":true}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["number"]},"numberFormat":{"type":"string","nullable":true},"value":{"type":"string"},"minValue":{"type":"number","nullable":true},"maxValue":{"type":"number","nullable":true},"textAlign":{"type":"string","enum":["left","center","right"]},"lineHeight":{"type":"number","minimum":1,"maximum":10,"description":"The line height of the text","nullable":true},"letterSpacing":{"type":"number","minimum":0,"maximum":100,"description":"The spacing between each character","nullable":true},"verticalAlign":{"type":"string","enum":["top","middle","bottom"],"description":"The vertical alignment of the text","nullable":true}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["radio"]},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"checked":{"type":"boolean"},"value":{"type":"string"}},"required":["id","checked","value"]}},"direction":{"default":"vertical","type":"string","enum":["vertical","horizontal"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["checkbox"]},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"checked":{"type":"boolean"},"value":{"type":"string"}},"required":["id","checked","value"]}},"validationRule":{"type":"string"},"validationLength":{"type":"number"},"direction":{"default":"vertical","type":"string","enum":["vertical","horizontal"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["dropdown"]},"values":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"]}},"defaultValue":{"type":"string"}},"required":["type"]}]}],"nullable":true}},"required":["id","recipientId","type","page","customText"]}},"Recipient":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"email":{"type":"string","format":"email","minLength":1},"name":{"type":"string"},"signingOrder":{"type":"number","nullable":true},"authOptions":{"nullable":true},"role":{"type":"string","enum":["CC","SIGNER","VIEWER","APPROVER","ASSISTANT"]}},"required":["id","email","name","role"]}}},"required":["id","type","title","userId","createdAt","updatedAt","directLink","Field","Recipient"]}},"totalPages":{"type":"number"}},"required":["templates","totalPages"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}}}},"/api/v1/templates/{id}":{"delete":{"description":"This endpoint is deprecated, but will continue to be supported. For more details, see https://docs.documenso.com/developers/public-api.","summary":"Delete a template","deprecated":true,"tags":[],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","required":true,"schema":{"type":"string"}}],"operationId":"deleteTemplate","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"externalId":{"type":"string","nullable":true},"type":{"type":"string","enum":["PUBLIC","PRIVATE"]},"title":{"type":"string"},"userId":{"type":"number"},"teamId":{"type":"number","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","type","title","userId","createdAt","updatedAt"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}}},"get":{"description":"This endpoint is deprecated, but will continue to be supported. For more details, see https://docs.documenso.com/developers/public-api.","summary":"Get a single template","deprecated":true,"tags":[],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","required":true,"schema":{"type":"string"}}],"operationId":"getTemplate","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"externalId":{"type":"string","nullable":true},"type":{"type":"string","enum":["PUBLIC","PRIVATE"]},"title":{"type":"string"},"userId":{"type":"number"},"teamId":{"type":"number","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"templateMeta":{"type":"object","properties":{"id":{"type":"string"},"subject":{"type":"string","nullable":true},"message":{"type":"string","nullable":true},"timezone":{"type":"string","nullable":true},"dateFormat":{"type":"string","nullable":true},"templateId":{"type":"number"},"redirectUrl":{"type":"string","nullable":true},"signingOrder":{"default":"PARALLEL","type":"string","enum":["PARALLEL","SEQUENTIAL"],"nullable":true}},"required":["id","templateId"],"nullable":true},"directLink":{"type":"object","properties":{"token":{"type":"string"},"enabled":{"type":"boolean"}},"required":["token","enabled"],"nullable":true},"templateDocumentData":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["S3_PATH","BYTES","BYTES_64"]},"data":{"type":"string"}},"required":["id","type","data"]},"Field":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"documentId":{"type":"number","nullable":true},"templateId":{"type":"number","nullable":true},"recipientId":{"type":"number"},"type":{"type":"string","enum":["SIGNATURE","FREE_SIGNATURE","INITIALS","NAME","EMAIL","DATE","TEXT","NUMBER","RADIO","CHECKBOX","DROPDOWN"]},"page":{"type":"number"},"positionX":{"nullable":true},"positionY":{"nullable":true},"width":{"nullable":true},"height":{"nullable":true},"customText":{"type":"string"},"fieldMeta":{"oneOf":[{"type":"object","properties":{},"additionalProperties":false},{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["signature"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["initials"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["name"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["email"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["date"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"characterLimit":{"type":"number","minimum":0,"nullable":true},"textAlign":{"type":"string","enum":["left","center","right"]},"lineHeight":{"type":"number","minimum":1,"maximum":10,"description":"The line height of the text","nullable":true},"letterSpacing":{"type":"number","minimum":0,"maximum":100,"description":"The spacing between each character","nullable":true},"verticalAlign":{"type":"string","enum":["top","middle","bottom"],"description":"The vertical alignment of the text","nullable":true}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["number"]},"numberFormat":{"type":"string","nullable":true},"value":{"type":"string"},"minValue":{"type":"number","nullable":true},"maxValue":{"type":"number","nullable":true},"textAlign":{"type":"string","enum":["left","center","right"]},"lineHeight":{"type":"number","minimum":1,"maximum":10,"description":"The line height of the text","nullable":true},"letterSpacing":{"type":"number","minimum":0,"maximum":100,"description":"The spacing between each character","nullable":true},"verticalAlign":{"type":"string","enum":["top","middle","bottom"],"description":"The vertical alignment of the text","nullable":true}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["radio"]},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"checked":{"type":"boolean"},"value":{"type":"string"}},"required":["id","checked","value"]}},"direction":{"default":"vertical","type":"string","enum":["vertical","horizontal"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["checkbox"]},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"checked":{"type":"boolean"},"value":{"type":"string"}},"required":["id","checked","value"]}},"validationRule":{"type":"string"},"validationLength":{"type":"number"},"direction":{"default":"vertical","type":"string","enum":["vertical","horizontal"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["dropdown"]},"values":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"]}},"defaultValue":{"type":"string"}},"required":["type"]}]}],"nullable":true}},"required":["id","recipientId","type","page","customText"]}},"Recipient":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"email":{"type":"string","format":"email","minLength":1},"name":{"type":"string"},"signingOrder":{"type":"number","nullable":true},"authOptions":{"nullable":true},"role":{"type":"string","enum":["CC","SIGNER","VIEWER","APPROVER","ASSISTANT"]}},"required":["id","email","name","role"]}}},"required":["id","type","title","userId","createdAt","updatedAt","directLink","templateDocumentData","Field","Recipient"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}}}},"/api/v1/templates/{templateId}/create-document":{"post":{"description":"This endpoint is deprecated, but will continue to be supported. For more details, see https://docs.documenso.com/developers/public-api. \n\nIf you must use the V1 API, use \"/api/v1/templates/:templateId/generate-document\" instead.","summary":"Create a new document from an existing template","deprecated":true,"tags":[],"parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","required":true,"schema":{"type":"string"}}],"operationId":"createDocumentFromTemplate","requestBody":{"description":"Body","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1},"externalId":{"type":"string","nullable":true},"recipients":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"email":{"type":"string","format":"email","minLength":1},"role":{"default":"SIGNER","type":"string","enum":["CC","SIGNER","VIEWER","APPROVER","ASSISTANT"]},"signingOrder":{"type":"number","nullable":true}},"required":["name","email"]}},"meta":{"type":"object","properties":{"subject":{"type":"string"},"message":{"type":"string"},"timezone":{"type":"string"},"dateFormat":{"type":"string"},"redirectUrl":{"type":"string"},"signingOrder":{"type":"string","enum":["PARALLEL","SEQUENTIAL"]},"allowDictateNextSigner":{"type":"boolean"},"language":{"type":"string","enum":["de","en","fr","es","it","nl","pl","pt-BR","ja","ko","zh"]}}},"authOptions":{"type":"object","properties":{"globalAccessAuth":{"default":[],"oneOf":[{"type":"string","enum":["ACCOUNT","TWO_FACTOR_AUTH"],"description":"The type of authentication required for the recipient to access the document."},{"type":"array","items":{"type":"string","enum":["ACCOUNT","TWO_FACTOR_AUTH"],"description":"The type of authentication required for the recipient to access the document."}}]},"globalActionAuth":{"default":[],"oneOf":[{"type":"string","enum":["ACCOUNT","PASSKEY","TWO_FACTOR_AUTH","PASSWORD"],"description":"The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only."},{"type":"array","items":{"type":"string","enum":["ACCOUNT","PASSKEY","TWO_FACTOR_AUTH","PASSWORD"],"description":"The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only."}}]}}},"formValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"number"}]}},"attachments":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1},"data":{"type":"string","format":"uri"},"type":{"default":"link","type":"string","enum":["link"]}},"required":["label","data"]}}},"required":["title","recipients"]}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"number"},"externalId":{"type":"string","nullable":true},"recipients":{"type":"array","items":{"type":"object","properties":{"recipientId":{"type":"number"},"name":{"type":"string"},"email":{"type":"string","format":"email","minLength":1},"token":{"type":"string"},"role":{"default":"SIGNER","type":"string","enum":["CC","SIGNER","VIEWER","APPROVER","ASSISTANT"]},"signingOrder":{"type":"number","nullable":true},"signingUrl":{"type":"string"}},"required":["recipientId","name","email","token","signingUrl"]}}},"required":["documentId","recipients"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}}}},"/api/v1/templates/{templateId}/generate-document":{"post":{"description":"This endpoint is deprecated, but will continue to be supported. For more details, see https://docs.documenso.com/developers/public-api. \n\nCreate a new document from an existing template. Passing in values for title and meta will override the original values defined in the template. If you do not pass in values for recipients, it will use the values defined in the template.","summary":"Create a new document from an existing template","deprecated":true,"tags":[],"parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","required":true,"schema":{"type":"string"}}],"operationId":"generateDocumentFromTemplate","requestBody":{"description":"Body","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"externalId":{"type":"string"},"folderId":{"type":"string","description":"The ID of the folder to create the document in. If not provided, the document will be created in the root folder."},"recipients":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"email":{"type":"string","format":"email"},"name":{"type":"string"},"signingOrder":{"type":"number"}},"required":["id","email"]}},"meta":{"type":"object","properties":{"subject":{"type":"string"},"message":{"type":"string"},"timezone":{"type":"string"},"dateFormat":{"type":"string"},"redirectUrl":{"type":"string"},"signingOrder":{"type":"string","enum":["PARALLEL","SEQUENTIAL"]},"allowDictateNextSigner":{"type":"boolean"},"language":{"type":"string","enum":["de","en","fr","es","it","nl","pl","pt-BR","ja","ko","zh"]},"distributionMethod":{"type":"string","enum":["EMAIL","NONE"]},"typedSignatureEnabled":{"type":"boolean"},"uploadSignatureEnabled":{"type":"boolean"},"drawSignatureEnabled":{"type":"boolean"},"emailSettings":{"nullable":true}}},"authOptions":{"type":"object","properties":{"globalAccessAuth":{"default":[],"oneOf":[{"type":"string","enum":["ACCOUNT","TWO_FACTOR_AUTH"],"description":"The type of authentication required for the recipient to access the document."},{"type":"array","items":{"type":"string","enum":["ACCOUNT","TWO_FACTOR_AUTH"],"description":"The type of authentication required for the recipient to access the document."}}]},"globalActionAuth":{"default":[],"oneOf":[{"type":"string","enum":["ACCOUNT","PASSKEY","TWO_FACTOR_AUTH","PASSWORD"],"description":"The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only."},{"type":"array","items":{"type":"string","enum":["ACCOUNT","PASSKEY","TWO_FACTOR_AUTH","PASSWORD"],"description":"The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only."}}]}}},"formValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"number"}]}},"prefillFields":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"number","description":"The numeric ID of the field in the template. Use when you have the field ID."},"secondaryId":{"type":"string","description":"The secondaryId of the field (e.g. rut, full_name, email). Use for CSV preset fields. Either id or secondaryId must be provided."}}},{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"label":{"type":"string"},"placeholder":{"type":"string"},"value":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","enum":["number"]},"label":{"type":"string"},"placeholder":{"type":"string"},"value":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","enum":["radio"]},"label":{"type":"string"},"value":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","enum":["checkbox"]},"label":{"type":"string"},"value":{"type":"array","items":{"type":"string"}}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","enum":["dropdown"]},"label":{"type":"string"},"value":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","enum":["date"]},"value":{"type":"string"}},"required":["type"]}]}]}}},"required":["recipients"]}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"number"},"externalId":{"type":"string","nullable":true},"recipients":{"type":"array","items":{"type":"object","properties":{"recipientId":{"type":"number"},"name":{"type":"string"},"email":{"type":"string","format":"email","minLength":1},"token":{"type":"string"},"role":{"type":"string","enum":["CC","SIGNER","VIEWER","APPROVER","ASSISTANT"]},"signingOrder":{"type":"number","nullable":true},"signingUrl":{"type":"string"}},"required":["recipientId","name","email","token","role","signingUrl"]}}},"required":["documentId","recipients"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"500":{"description":"500","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}}}},"/api/v1/documents/{id}/send":{"post":{"description":"This endpoint is deprecated, but will continue to be supported. For more details, see https://docs.documenso.com/developers/public-api. \n\nNotes\n\nsendEmail - Whether to send an email to the recipients asking them to action the document. If you disable this, you will need to manually distribute the document to the recipients using the generated signing links. Defaults to true","summary":"Send a document for signing","deprecated":true,"tags":[],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","required":true,"schema":{"type":"string"}}],"operationId":"sendDocument","requestBody":{"description":"Body","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"sendEmail":{"default":true,"type":"boolean","description":"Whether to send an email to the recipients asking them to action the document. If you disable this, you will need to manually distribute the document to the recipients using the generated signing links."},"sendCompletionEmails":{"type":"boolean","description":"Whether to send completion emails when the document is fully signed. This will override the document email settings."}}},{"nullable":true}],"nullable":true}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]},{"type":"object","properties":{"id":{"type":"number"},"externalId":{"type":"string","nullable":true},"userId":{"type":"number"},"teamId":{"type":"number","nullable":true},"title":{"type":"string"},"status":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","format":"date-time","nullable":true},"recipients":{}},"required":["id","userId","title","status","createdAt","updatedAt","completedAt","recipients"]}]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"500":{"description":"500","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}}}},"/api/v1/documents/{id}/resend":{"post":{"description":"This endpoint is deprecated, but will continue to be supported. For more details, see https://docs.documenso.com/developers/public-api.","summary":"Re-send a document for signing","deprecated":true,"tags":[],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","required":true,"schema":{"type":"string"}}],"operationId":"resendDocument","requestBody":{"description":"Body","content":{"application/json":{"schema":{"type":"object","properties":{"recipients":{"type":"array","items":{"type":"number"}}},"required":["recipients"]}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"500":{"description":"500","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}}}},"/api/v1/documents/{id}/recipients":{"post":{"description":"This endpoint is deprecated, but will continue to be supported. For more details, see https://docs.documenso.com/developers/public-api.","summary":"Create a recipient for a document","deprecated":true,"tags":[],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","required":true,"schema":{"type":"string"}}],"operationId":"createRecipient","requestBody":{"description":"Body","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"email":{"type":"string","format":"email","minLength":1},"role":{"default":"SIGNER","type":"string","enum":["CC","SIGNER","VIEWER","APPROVER","ASSISTANT"]},"signingOrder":{"type":"number","nullable":true},"authOptions":{"type":"object","properties":{"actionAuth":{"default":[],"oneOf":[{"type":"string","enum":["ACCOUNT","PASSKEY","TWO_FACTOR_AUTH","PASSWORD","EXPLICIT_NONE"],"description":"The type of authentication required for the recipient to sign the document."},{"type":"array","items":{"type":"string","enum":["ACCOUNT","PASSKEY","TWO_FACTOR_AUTH","PASSWORD","EXPLICIT_NONE"],"description":"The type of authentication required for the recipient to sign the document."}}]}},"description":"The authOptions property is only available for Enterprise accounts."}},"required":["name","email"]}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"documentId":{"default":-1,"type":"number","nullable":true},"email":{"type":"string","format":"email","minLength":1},"name":{"type":"string"},"role":{"type":"string","enum":["CC","SIGNER","VIEWER","APPROVER","ASSISTANT"]},"signingOrder":{"type":"number","nullable":true},"token":{"type":"string"},"signedAt":{"type":"string","format":"date-time","nullable":true},"readStatus":{"type":"string","enum":["NOT_OPENED","OPENED"]},"signingStatus":{"type":"string","enum":["NOT_SIGNED","SIGNED","REJECTED"]},"sendStatus":{"type":"string","enum":["NOT_SENT","SENT"]},"signingUrl":{"type":"string"}},"required":["id","email","name","role","token","signedAt","readStatus","signingStatus","sendStatus","signingUrl"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"500":{"description":"500","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}}}},"/api/v1/documents/{id}/recipients/{recipientId}":{"patch":{"description":"This endpoint is deprecated, but will continue to be supported. For more details, see https://docs.documenso.com/developers/public-api.","summary":"Update a recipient for a document","deprecated":true,"tags":[],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"recipientId","in":"path","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","required":true,"schema":{"type":"string"}}],"operationId":"updateRecipient","requestBody":{"description":"Body","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"email":{"type":"string","format":"email","minLength":1},"role":{"default":"SIGNER","type":"string","enum":["CC","SIGNER","VIEWER","APPROVER","ASSISTANT"]},"signingOrder":{"type":"number","nullable":true},"authOptions":{"type":"object","properties":{"actionAuth":{"default":[],"oneOf":[{"type":"string","enum":["ACCOUNT","PASSKEY","TWO_FACTOR_AUTH","PASSWORD","EXPLICIT_NONE"],"description":"The type of authentication required for the recipient to sign the document."},{"type":"array","items":{"type":"string","enum":["ACCOUNT","PASSKEY","TWO_FACTOR_AUTH","PASSWORD","EXPLICIT_NONE"],"description":"The type of authentication required for the recipient to sign the document."}}]}},"description":"The authOptions property is only available for Enterprise accounts."}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"documentId":{"default":-1,"type":"number","nullable":true},"email":{"type":"string","format":"email","minLength":1},"name":{"type":"string"},"role":{"type":"string","enum":["CC","SIGNER","VIEWER","APPROVER","ASSISTANT"]},"signingOrder":{"type":"number","nullable":true},"token":{"type":"string"},"signedAt":{"type":"string","format":"date-time","nullable":true},"readStatus":{"type":"string","enum":["NOT_OPENED","OPENED"]},"signingStatus":{"type":"string","enum":["NOT_SIGNED","SIGNED","REJECTED"]},"sendStatus":{"type":"string","enum":["NOT_SENT","SENT"]},"signingUrl":{"type":"string"}},"required":["id","email","name","role","token","signedAt","readStatus","signingStatus","sendStatus","signingUrl"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"500":{"description":"500","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}}},"delete":{"description":"This endpoint is deprecated, but will continue to be supported. For more details, see https://docs.documenso.com/developers/public-api.","summary":"Delete a recipient from a document","deprecated":true,"tags":[],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"recipientId","in":"path","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","required":true,"schema":{"type":"string"}}],"operationId":"deleteRecipient","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"documentId":{"default":-1,"type":"number","nullable":true},"email":{"type":"string","format":"email","minLength":1},"name":{"type":"string"},"role":{"type":"string","enum":["CC","SIGNER","VIEWER","APPROVER","ASSISTANT"]},"signingOrder":{"type":"number","nullable":true},"token":{"type":"string"},"signedAt":{"type":"string","format":"date-time","nullable":true},"readStatus":{"type":"string","enum":["NOT_OPENED","OPENED"]},"signingStatus":{"type":"string","enum":["NOT_SIGNED","SIGNED","REJECTED"]},"sendStatus":{"type":"string","enum":["NOT_SENT","SENT"]},"signingUrl":{"type":"string"}},"required":["id","email","name","role","token","signedAt","readStatus","signingStatus","sendStatus","signingUrl"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"500":{"description":"500","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}}}},"/api/v1/documents/{id}/fields":{"post":{"description":"This endpoint is deprecated, but will continue to be supported. For more details, see https://docs.documenso.com/developers/public-api.","summary":"Create a field for a document","deprecated":true,"tags":[],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","required":true,"schema":{"type":"string"}}],"operationId":"createField","requestBody":{"description":"Body","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"recipientId":{"type":"number"},"type":{"type":"string","enum":["SIGNATURE","FREE_SIGNATURE","INITIALS","NAME","EMAIL","DATE","TEXT","NUMBER","RADIO","CHECKBOX","DROPDOWN"]},"pageNumber":{"type":"number"},"pageX":{"type":"number"},"pageY":{"type":"number"},"pageWidth":{"type":"number"},"pageHeight":{"type":"number"},"fieldMeta":{"oneOf":[{"type":"object","properties":{},"additionalProperties":false},{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["signature"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["initials"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["name"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["email"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["date"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"characterLimit":{"type":"number","minimum":0,"nullable":true},"textAlign":{"type":"string","enum":["left","center","right"]},"lineHeight":{"type":"number","minimum":1,"maximum":10,"description":"The line height of the text","nullable":true},"letterSpacing":{"type":"number","minimum":0,"maximum":100,"description":"The spacing between each character","nullable":true},"verticalAlign":{"type":"string","enum":["top","middle","bottom"],"description":"The vertical alignment of the text","nullable":true}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["number"]},"numberFormat":{"type":"string","nullable":true},"value":{"type":"string"},"minValue":{"type":"number","nullable":true},"maxValue":{"type":"number","nullable":true},"textAlign":{"type":"string","enum":["left","center","right"]},"lineHeight":{"type":"number","minimum":1,"maximum":10,"description":"The line height of the text","nullable":true},"letterSpacing":{"type":"number","minimum":0,"maximum":100,"description":"The spacing between each character","nullable":true},"verticalAlign":{"type":"string","enum":["top","middle","bottom"],"description":"The vertical alignment of the text","nullable":true}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["radio"]},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"checked":{"type":"boolean"},"value":{"type":"string"}},"required":["id","checked","value"]}},"direction":{"default":"vertical","type":"string","enum":["vertical","horizontal"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["checkbox"]},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"checked":{"type":"boolean"},"value":{"type":"string"}},"required":["id","checked","value"]}},"validationRule":{"type":"string"},"validationLength":{"type":"number"},"direction":{"default":"vertical","type":"string","enum":["vertical","horizontal"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["dropdown"]},"values":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"]}},"defaultValue":{"type":"string"}},"required":["type"]}]}]}},"required":["recipientId","type","pageNumber","pageX","pageY","pageWidth","pageHeight"]},{"type":"array","items":{"type":"object","properties":{"recipientId":{"type":"number"},"type":{"type":"string","enum":["SIGNATURE","FREE_SIGNATURE","INITIALS","NAME","EMAIL","DATE","TEXT","NUMBER","RADIO","CHECKBOX","DROPDOWN"]},"pageNumber":{"type":"number"},"pageX":{"type":"number"},"pageY":{"type":"number"},"pageWidth":{"type":"number"},"pageHeight":{"type":"number"},"fieldMeta":{"oneOf":[{"type":"object","properties":{},"additionalProperties":false},{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["signature"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["initials"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["name"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["email"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["date"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"characterLimit":{"type":"number","minimum":0,"nullable":true},"textAlign":{"type":"string","enum":["left","center","right"]},"lineHeight":{"type":"number","minimum":1,"maximum":10,"description":"The line height of the text","nullable":true},"letterSpacing":{"type":"number","minimum":0,"maximum":100,"description":"The spacing between each character","nullable":true},"verticalAlign":{"type":"string","enum":["top","middle","bottom"],"description":"The vertical alignment of the text","nullable":true}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["number"]},"numberFormat":{"type":"string","nullable":true},"value":{"type":"string"},"minValue":{"type":"number","nullable":true},"maxValue":{"type":"number","nullable":true},"textAlign":{"type":"string","enum":["left","center","right"]},"lineHeight":{"type":"number","minimum":1,"maximum":10,"description":"The line height of the text","nullable":true},"letterSpacing":{"type":"number","minimum":0,"maximum":100,"description":"The spacing between each character","nullable":true},"verticalAlign":{"type":"string","enum":["top","middle","bottom"],"description":"The vertical alignment of the text","nullable":true}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["radio"]},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"checked":{"type":"boolean"},"value":{"type":"string"}},"required":["id","checked","value"]}},"direction":{"default":"vertical","type":"string","enum":["vertical","horizontal"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["checkbox"]},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"checked":{"type":"boolean"},"value":{"type":"string"}},"required":["id","checked","value"]}},"validationRule":{"type":"string"},"validationLength":{"type":"number"},"direction":{"default":"vertical","type":"string","enum":["vertical","horizontal"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["dropdown"]},"values":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"]}},"defaultValue":{"type":"string"}},"required":["type"]}]}]}},"required":["recipientId","type","pageNumber","pageX","pageY","pageWidth","pageHeight"]},"minItems":1}]}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"fields":{"oneOf":[{"type":"object","properties":{"id":{"type":"number"},"documentId":{"type":"number"},"recipientId":{"type":"number"},"type":{"type":"string","enum":["SIGNATURE","FREE_SIGNATURE","INITIALS","NAME","EMAIL","DATE","TEXT","NUMBER","RADIO","CHECKBOX","DROPDOWN"]},"pageNumber":{"type":"number"},"pageX":{"type":"number"},"pageY":{"type":"number"},"pageWidth":{"type":"number"},"pageHeight":{"type":"number"},"customText":{"type":"string"},"fieldMeta":{"oneOf":[{"type":"object","properties":{},"additionalProperties":false},{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["signature"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["initials"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["name"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["email"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["date"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"characterLimit":{"type":"number","minimum":0,"nullable":true},"textAlign":{"type":"string","enum":["left","center","right"]},"lineHeight":{"type":"number","minimum":1,"maximum":10,"description":"The line height of the text","nullable":true},"letterSpacing":{"type":"number","minimum":0,"maximum":100,"description":"The spacing between each character","nullable":true},"verticalAlign":{"type":"string","enum":["top","middle","bottom"],"description":"The vertical alignment of the text","nullable":true}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["number"]},"numberFormat":{"type":"string","nullable":true},"value":{"type":"string"},"minValue":{"type":"number","nullable":true},"maxValue":{"type":"number","nullable":true},"textAlign":{"type":"string","enum":["left","center","right"]},"lineHeight":{"type":"number","minimum":1,"maximum":10,"description":"The line height of the text","nullable":true},"letterSpacing":{"type":"number","minimum":0,"maximum":100,"description":"The spacing between each character","nullable":true},"verticalAlign":{"type":"string","enum":["top","middle","bottom"],"description":"The vertical alignment of the text","nullable":true}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["radio"]},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"checked":{"type":"boolean"},"value":{"type":"string"}},"required":["id","checked","value"]}},"direction":{"default":"vertical","type":"string","enum":["vertical","horizontal"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["checkbox"]},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"checked":{"type":"boolean"},"value":{"type":"string"}},"required":["id","checked","value"]}},"validationRule":{"type":"string"},"validationLength":{"type":"number"},"direction":{"default":"vertical","type":"string","enum":["vertical","horizontal"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["dropdown"]},"values":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"]}},"defaultValue":{"type":"string"}},"required":["type"]}]}]},"inserted":{"type":"boolean"}},"required":["id","documentId","recipientId","type","pageNumber","pageX","pageY","pageWidth","pageHeight","customText","inserted"]},{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"documentId":{"type":"number"},"recipientId":{"type":"number"},"type":{"type":"string","enum":["SIGNATURE","FREE_SIGNATURE","INITIALS","NAME","EMAIL","DATE","TEXT","NUMBER","RADIO","CHECKBOX","DROPDOWN"]},"pageNumber":{"type":"number"},"pageX":{"type":"number"},"pageY":{"type":"number"},"pageWidth":{"type":"number"},"pageHeight":{"type":"number"},"customText":{"type":"string"},"fieldMeta":{"oneOf":[{"type":"object","properties":{},"additionalProperties":false},{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["signature"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["initials"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["name"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["email"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["date"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"characterLimit":{"type":"number","minimum":0,"nullable":true},"textAlign":{"type":"string","enum":["left","center","right"]},"lineHeight":{"type":"number","minimum":1,"maximum":10,"description":"The line height of the text","nullable":true},"letterSpacing":{"type":"number","minimum":0,"maximum":100,"description":"The spacing between each character","nullable":true},"verticalAlign":{"type":"string","enum":["top","middle","bottom"],"description":"The vertical alignment of the text","nullable":true}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["number"]},"numberFormat":{"type":"string","nullable":true},"value":{"type":"string"},"minValue":{"type":"number","nullable":true},"maxValue":{"type":"number","nullable":true},"textAlign":{"type":"string","enum":["left","center","right"]},"lineHeight":{"type":"number","minimum":1,"maximum":10,"description":"The line height of the text","nullable":true},"letterSpacing":{"type":"number","minimum":0,"maximum":100,"description":"The spacing between each character","nullable":true},"verticalAlign":{"type":"string","enum":["top","middle","bottom"],"description":"The vertical alignment of the text","nullable":true}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["radio"]},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"checked":{"type":"boolean"},"value":{"type":"string"}},"required":["id","checked","value"]}},"direction":{"default":"vertical","type":"string","enum":["vertical","horizontal"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["checkbox"]},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"checked":{"type":"boolean"},"value":{"type":"string"}},"required":["id","checked","value"]}},"validationRule":{"type":"string"},"validationLength":{"type":"number"},"direction":{"default":"vertical","type":"string","enum":["vertical","horizontal"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["dropdown"]},"values":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"]}},"defaultValue":{"type":"string"}},"required":["type"]}]}]},"inserted":{"type":"boolean"}},"required":["id","documentId","recipientId","type","pageNumber","pageX","pageY","pageWidth","pageHeight","customText","inserted"]}}]},"documentId":{"type":"number"}},"required":["fields","documentId"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"500":{"description":"500","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}}}},"/api/v1/documents/{id}/fields/{fieldId}":{"patch":{"description":"This endpoint is deprecated, but will continue to be supported. For more details, see https://docs.documenso.com/developers/public-api.","summary":"Update a field for a document","deprecated":true,"tags":[],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldId","in":"path","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","required":true,"schema":{"type":"string"}}],"operationId":"updateField","requestBody":{"description":"Body","content":{"application/json":{"schema":{"type":"object","properties":{"recipientId":{"type":"number"},"type":{"type":"string","enum":["SIGNATURE","FREE_SIGNATURE","INITIALS","NAME","EMAIL","DATE","TEXT","NUMBER","RADIO","CHECKBOX","DROPDOWN"]},"pageNumber":{"type":"number"},"pageX":{"type":"number"},"pageY":{"type":"number"},"pageWidth":{"type":"number"},"pageHeight":{"type":"number"},"fieldMeta":{"oneOf":[{"type":"object","properties":{},"additionalProperties":false},{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["signature"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["initials"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["name"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["email"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["date"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"characterLimit":{"type":"number","minimum":0,"nullable":true},"textAlign":{"type":"string","enum":["left","center","right"]},"lineHeight":{"type":"number","minimum":1,"maximum":10,"description":"The line height of the text","nullable":true},"letterSpacing":{"type":"number","minimum":0,"maximum":100,"description":"The spacing between each character","nullable":true},"verticalAlign":{"type":"string","enum":["top","middle","bottom"],"description":"The vertical alignment of the text","nullable":true}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["number"]},"numberFormat":{"type":"string","nullable":true},"value":{"type":"string"},"minValue":{"type":"number","nullable":true},"maxValue":{"type":"number","nullable":true},"textAlign":{"type":"string","enum":["left","center","right"]},"lineHeight":{"type":"number","minimum":1,"maximum":10,"description":"The line height of the text","nullable":true},"letterSpacing":{"type":"number","minimum":0,"maximum":100,"description":"The spacing between each character","nullable":true},"verticalAlign":{"type":"string","enum":["top","middle","bottom"],"description":"The vertical alignment of the text","nullable":true}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["radio"]},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"checked":{"type":"boolean"},"value":{"type":"string"}},"required":["id","checked","value"]}},"direction":{"default":"vertical","type":"string","enum":["vertical","horizontal"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["checkbox"]},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"checked":{"type":"boolean"},"value":{"type":"string"}},"required":["id","checked","value"]}},"validationRule":{"type":"string"},"validationLength":{"type":"number"},"direction":{"default":"vertical","type":"string","enum":["vertical","horizontal"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["dropdown"]},"values":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"]}},"defaultValue":{"type":"string"}},"required":["type"]}]}]}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"documentId":{"type":"number"},"recipientId":{"type":"number"},"type":{"type":"string","enum":["SIGNATURE","FREE_SIGNATURE","INITIALS","NAME","EMAIL","DATE","TEXT","NUMBER","RADIO","CHECKBOX","DROPDOWN"]},"pageNumber":{"type":"number"},"pageX":{"type":"number"},"pageY":{"type":"number"},"pageWidth":{"type":"number"},"pageHeight":{"type":"number"},"customText":{"type":"string"},"fieldMeta":{"oneOf":[{"type":"object","properties":{},"additionalProperties":false},{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["signature"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["initials"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["name"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["email"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["date"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"characterLimit":{"type":"number","minimum":0,"nullable":true},"textAlign":{"type":"string","enum":["left","center","right"]},"lineHeight":{"type":"number","minimum":1,"maximum":10,"description":"The line height of the text","nullable":true},"letterSpacing":{"type":"number","minimum":0,"maximum":100,"description":"The spacing between each character","nullable":true},"verticalAlign":{"type":"string","enum":["top","middle","bottom"],"description":"The vertical alignment of the text","nullable":true}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["number"]},"numberFormat":{"type":"string","nullable":true},"value":{"type":"string"},"minValue":{"type":"number","nullable":true},"maxValue":{"type":"number","nullable":true},"textAlign":{"type":"string","enum":["left","center","right"]},"lineHeight":{"type":"number","minimum":1,"maximum":10,"description":"The line height of the text","nullable":true},"letterSpacing":{"type":"number","minimum":0,"maximum":100,"description":"The spacing between each character","nullable":true},"verticalAlign":{"type":"string","enum":["top","middle","bottom"],"description":"The vertical alignment of the text","nullable":true}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["radio"]},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"checked":{"type":"boolean"},"value":{"type":"string"}},"required":["id","checked","value"]}},"direction":{"default":"vertical","type":"string","enum":["vertical","horizontal"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["checkbox"]},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"checked":{"type":"boolean"},"value":{"type":"string"}},"required":["id","checked","value"]}},"validationRule":{"type":"string"},"validationLength":{"type":"number"},"direction":{"default":"vertical","type":"string","enum":["vertical","horizontal"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["dropdown"]},"values":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"]}},"defaultValue":{"type":"string"}},"required":["type"]}]}]},"inserted":{"type":"boolean"}},"required":["id","documentId","recipientId","type","pageNumber","pageX","pageY","pageWidth","pageHeight","customText","inserted"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"500":{"description":"500","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}}},"delete":{"description":"This endpoint is deprecated, but will continue to be supported. For more details, see https://docs.documenso.com/developers/public-api.","summary":"Delete a field from a document","deprecated":true,"tags":[],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldId","in":"path","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","required":true,"schema":{"type":"string"}}],"operationId":"deleteField","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"documentId":{"type":"number"},"recipientId":{"type":"number"},"type":{"type":"string","enum":["SIGNATURE","FREE_SIGNATURE","INITIALS","NAME","EMAIL","DATE","TEXT","NUMBER","RADIO","CHECKBOX","DROPDOWN"]},"pageNumber":{"type":"number"},"pageX":{"type":"number"},"pageY":{"type":"number"},"pageWidth":{"type":"number"},"pageHeight":{"type":"number"},"customText":{"type":"string"},"fieldMeta":{"oneOf":[{"type":"object","properties":{},"additionalProperties":false},{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["signature"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["initials"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["name"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["email"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["date"]},"textAlign":{"type":"string","enum":["left","center","right"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"characterLimit":{"type":"number","minimum":0,"nullable":true},"textAlign":{"type":"string","enum":["left","center","right"]},"lineHeight":{"type":"number","minimum":1,"maximum":10,"description":"The line height of the text","nullable":true},"letterSpacing":{"type":"number","minimum":0,"maximum":100,"description":"The spacing between each character","nullable":true},"verticalAlign":{"type":"string","enum":["top","middle","bottom"],"description":"The vertical alignment of the text","nullable":true}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["number"]},"numberFormat":{"type":"string","nullable":true},"value":{"type":"string"},"minValue":{"type":"number","nullable":true},"maxValue":{"type":"number","nullable":true},"textAlign":{"type":"string","enum":["left","center","right"]},"lineHeight":{"type":"number","minimum":1,"maximum":10,"description":"The line height of the text","nullable":true},"letterSpacing":{"type":"number","minimum":0,"maximum":100,"description":"The spacing between each character","nullable":true},"verticalAlign":{"type":"string","enum":["top","middle","bottom"],"description":"The vertical alignment of the text","nullable":true}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["radio"]},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"checked":{"type":"boolean"},"value":{"type":"string"}},"required":["id","checked","value"]}},"direction":{"default":"vertical","type":"string","enum":["vertical","horizontal"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["checkbox"]},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"checked":{"type":"boolean"},"value":{"type":"string"}},"required":["id","checked","value"]}},"validationRule":{"type":"string"},"validationLength":{"type":"number"},"direction":{"default":"vertical","type":"string","enum":["vertical","horizontal"]}},"required":["type"]},{"type":"object","properties":{"label":{"type":"string"},"placeholder":{"type":"string"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"fontSize":{"default":10,"type":"number","minimum":8,"maximum":96},"type":{"type":"string","enum":["dropdown"]},"values":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"]}},"defaultValue":{"type":"string"}},"required":["type"]}]}]},"inserted":{"type":"boolean"}},"required":["id","documentId","recipientId","type","pageNumber","pageX","pageY","pageWidth","pageHeight","customText","inserted"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"500":{"description":"500","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}}}}},"info":{"title":"Documenso API","version":"1.0.0","description":"API V1 is deprecated, but will continue to be supported. For more details, see https://docs.documenso.com/developers/public-api. \n\nThe Documenso API for retrieving, creating, updating and deleting documents."},"servers":[{"url":"https://docs.kpitaljobs.cl"}],"components":{"securitySchemes":{"authorization":{"type":"apiKey","in":"header","name":"Authorization"}}},"security":[{"authorization":[]}]}