{ "openapi": "3.1.1", "info": { "title": "Documenso v2 API", "description": "Welcome to the Documenso v2 API.\n\nThis API provides access to our system, which you can use to integrate applications, automate workflows, or build custom tools.", "version": "1.0.0" }, "servers": [ { "url": "https://app.documenso.com/api/v2" } ], "paths": { "/envelope/attachment": { "get": { "operationId": "envelope-attachment-find", "summary": "Find attachments", "description": "Find all attachments for an envelope", "tags": [ "Envelope Attachments" ], "security": [ { "apiKey": [] } ], "parameters": [ { "in": "query", "name": "envelopeId", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "token", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "link" ] }, "label": { "type": "string" }, "data": { "type": "string" } }, "required": [ "id", "type", "label", "data" ] } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "envelopes.attachments", "x-speakeasy-name-override": "find", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelopes.attachments.find({\n envelopeId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelopes.Attachments.Find(ctx, \"\", nil)\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelopes.attachments.find(envelope_id=\"\")\n\n # Handle response\n print(res)" } ] } }, "/envelope/attachment/create": { "post": { "operationId": "envelope-attachment-create", "summary": "Create attachment", "description": "Create a new attachment for an envelope", "tags": [ "Envelope Attachments" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "data": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "data": { "type": "string", "format": "uri" } }, "required": [ "label", "data" ] } }, "required": [ "envelopeId", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "envelopes.attachments", "x-speakeasy-name-override": "create", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelopes.attachments.create({\n envelopeId: \"\",\n data: {\n label: \"\",\n data: \"https://lustrous-skeleton.info\",\n },\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelopes.Attachments.Create(ctx, operations.EnvelopeAttachmentCreateRequest{\n EnvelopeID: \"\",\n Data: operations.EnvelopeAttachmentCreateData{\n Label: \"\",\n Data: \"https://lustrous-skeleton.info\",\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelopes.attachments.create(envelope_id=\"\", data={\n \"label\": \"\",\n \"data\": \"https://lustrous-skeleton.info\",\n })\n\n # Handle response\n print(res)" } ] } }, "/envelope/attachment/update": { "post": { "operationId": "envelope-attachment-update", "summary": "Update attachment", "description": "Update an existing attachment", "tags": [ "Envelope Attachments" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "data": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "data": { "type": "string", "format": "uri" } }, "required": [ "label", "data" ] } }, "required": [ "id", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "envelopes.attachments", "x-speakeasy-name-override": "update", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelopes.attachments.update({\n id: \"\",\n data: {\n label: \"\",\n data: \"https://tough-premier.biz\",\n },\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelopes.Attachments.Update(ctx, operations.EnvelopeAttachmentUpdateRequest{\n ID: \"\",\n Data: operations.EnvelopeAttachmentUpdateData{\n Label: \"\",\n Data: \"https://tough-premier.biz\",\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelopes.attachments.update(id=\"\", data={\n \"label\": \"\",\n \"data\": \"https://tough-premier.biz\",\n })\n\n # Handle response\n print(res)" } ] } }, "/envelope/attachment/delete": { "post": { "operationId": "envelope-attachment-delete", "summary": "Delete attachment", "description": "Delete an attachment from an envelope", "tags": [ "Envelope Attachments" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "envelopes.attachments", "x-speakeasy-name-override": "delete", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelopes.attachments.delete({\n id: \"\",\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelopes.Attachments.Delete(ctx, operations.EnvelopeAttachmentDeleteRequest{\n ID: \"\",\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelopes.attachments.delete(id=\"\")\n\n # Handle response\n print(res)" } ] } }, "/envelope/item/create-many": { "post": { "operationId": "envelope-item-createMany", "summary": "Create envelope items", "description": "Create multiple envelope items for an envelope", "tags": [ "Envelope Items" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "envelopeId": { "type": "string" } }, "required": [ "envelopeId" ] }, "files": { "type": "array", "items": { "type": "string", "contentMediaType": "application/octet-stream" } } }, "required": [ "payload" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "envelopeId": { "type": "string" }, "order": { "type": "number" }, "documentDataId": { "type": "string" } }, "required": [ "id", "title", "envelopeId", "order", "documentDataId" ] } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "envelopes.items", "x-speakeasy-name-override": "createMany", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelopes.items.createMany({\n payload: {\n envelopeId: \"\",\n },\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelopes.Items.CreateMany(ctx, operations.EnvelopeItemCreateManyRequest{\n Payload: operations.EnvelopeItemCreateManyPayload{\n EnvelopeID: \"\",\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelopes.items.create_many(payload={\n \"envelope_id\": \"\",\n })\n\n # Handle response\n print(res)" } ] } }, "/envelope/item/update-many": { "post": { "operationId": "envelope-item-updateMany", "summary": "Update envelope items", "description": "Update multiple envelope items for an envelope", "tags": [ "Envelope Items" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "envelopeItemId": { "type": "string" }, "order": { "type": "integer", "minimum": 1 }, "title": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": [ "envelopeItemId" ] }, "minItems": 1 } }, "required": [ "envelopeId", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "order": { "type": "number" }, "title": { "type": "string" }, "envelopeId": { "type": "string" } }, "required": [ "id", "order", "title", "envelopeId" ] } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "envelopes.items", "x-speakeasy-name-override": "updateMany", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelopes.items.updateMany({\n envelopeId: \"\",\n data: [],\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelopes.Items.UpdateMany(ctx, operations.EnvelopeItemUpdateManyRequest{\n EnvelopeID: \"\",\n Data: []operations.EnvelopeItemUpdateManyDataRequest{},\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelopes.items.update_many(envelope_id=\"\", data=[])\n\n # Handle response\n print(res)" } ] } }, "/envelope/item/delete": { "post": { "operationId": "envelope-item-delete", "summary": "Delete envelope item", "description": "Delete an envelope item from an envelope", "tags": [ "Envelope Items" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "envelopeItemId": { "type": "string" } }, "required": [ "envelopeId", "envelopeItemId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "envelopes.items", "x-speakeasy-name-override": "delete", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelopes.items.delete({\n envelopeId: \"\",\n envelopeItemId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelopes.Items.Delete(ctx, operations.EnvelopeItemDeleteRequest{\n EnvelopeID: \"\",\n EnvelopeItemID: \"\",\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelopes.items.delete(envelope_id=\"\", envelope_item_id=\"\")\n\n # Handle response\n print(res)" } ] } }, "/envelope/item/{envelopeItemId}/download": { "get": { "operationId": "envelope-item-download", "summary": "Download an envelope item", "description": "Download an envelope item by its ID", "tags": [ "Envelope Items" ], "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "envelopeItemId", "description": "The ID of the envelope item to download.", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "version", "description": "The version of the envelope item to download. \"signed\" returns the completed document with all signatures and the audit trail, \"original\" returns the original uploaded document, \"pending\" returns the original document with currently-inserted fields burned in (only valid while the envelope is in PENDING status; not a final executed document).", "schema": { "type": "string", "enum": [ "original", "signed", "pending" ], "default": "signed" } } ], "responses": { "200": { "description": "Successful response", "headers": { "Content-Type": { "schema": { "type": "string", "enum": [ "application/pdf" ] }, "required": true } }, "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "envelopes.items", "x-speakeasy-name-override": "download", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelopes.items.download({\n envelopeItemId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelopes.Items.Download(ctx, \"\", operations.EnvelopeItemDownloadVersionSigned.ToPointer())\n if err != nil {\n log.Fatal(err)\n }\n if res.Any != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "import documenso_sdk\nfrom documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelopes.items.download(envelope_item_id=\"\", version=documenso_sdk.EnvelopeItemDownloadVersion.SIGNED)\n\n # Handle response\n print(res)" } ] } }, "/envelope/recipient/{recipientId}": { "get": { "operationId": "envelope-recipient-get", "summary": "Get envelope recipient", "description": "Returns an envelope recipient given an ID", "tags": [ "Envelope Recipients" ], "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "recipientId", "schema": { "type": "number" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "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", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] }, "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "signingOrder", "rejectionReason", "fields" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "envelopes.recipients", "x-speakeasy-name-override": "get", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelopes.recipients.get({\n recipientId: 8771.72,\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelopes.Recipients.Get(ctx, 8771.72)\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelopes.recipients.get(recipient_id=8771.72)\n\n # Handle response\n print(res)" } ] } }, "/envelope/recipient/create-many": { "post": { "operationId": "envelope-recipient-createMany", "summary": "Create envelope recipients", "description": "Create multiple recipients for an envelope", "tags": [ "Envelope Recipients" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "email": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": "string", "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$", "maxLength": 254 } ] }, "name": { "type": "string", "maxLength": 255 }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "signingOrder": { "type": "number" }, "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] }, "default": [] }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] }, "default": [] } }, "required": [ "email", "name", "role" ] } } }, "required": [ "envelopeId", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "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", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "signingOrder", "rejectionReason" ] } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "envelopes.recipients", "x-speakeasy-name-override": "createMany", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelopes.recipients.createMany({\n envelopeId: \"\",\n data: [\n {\n email: \"Ed16@yahoo.com\",\n name: \"\",\n role: \"SIGNER\",\n },\n ],\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelopes.Recipients.CreateMany(ctx, operations.EnvelopeRecipientCreateManyRequest{\n EnvelopeID: \"\",\n Data: []operations.EnvelopeRecipientCreateManyDataRequest{\n operations.EnvelopeRecipientCreateManyDataRequest{\n Email: operations.CreateEnvelopeRecipientCreateManyEmailUnionEnvelopeRecipientCreateManyEmailEnum(\n operations.EnvelopeRecipientCreateManyEmailEnumUnknown,\n ),\n Name: \"\",\n Role: operations.EnvelopeRecipientCreateManyRoleRequestSigner,\n },\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "import documenso_sdk\nfrom documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelopes.recipients.create_many(envelope_id=\"\", data=[\n {\n \"email\": documenso_sdk.EnvelopeRecipientCreateManyEmailEnum.UNKNOWN,\n \"name\": \"\",\n \"role\": documenso_sdk.EnvelopeRecipientCreateManyRoleRequest.SIGNER,\n },\n ])\n\n # Handle response\n print(res)" } ] } }, "/envelope/recipient/update-many": { "post": { "operationId": "envelope-recipient-updateMany", "summary": "Update envelope recipients", "description": "Update multiple recipients for an envelope", "tags": [ "Envelope Recipients" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "email": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": "string", "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$", "maxLength": 254 } ] }, "name": { "type": "string", "maxLength": 255 }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "signingOrder": { "type": "number" }, "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] }, "default": [] }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] }, "default": [] } }, "required": [ "id" ] } } }, "required": [ "envelopeId", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "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", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "signingOrder", "rejectionReason" ] } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "envelopes.recipients", "x-speakeasy-name-override": "updateMany", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelopes.recipients.updateMany({\n envelopeId: \"\",\n data: [\n {\n id: 8894.57,\n },\n ],\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelopes.Recipients.UpdateMany(ctx, operations.EnvelopeRecipientUpdateManyRequest{\n EnvelopeID: \"\",\n Data: []operations.EnvelopeRecipientUpdateManyDataRequest{\n operations.EnvelopeRecipientUpdateManyDataRequest{\n ID: 8894.57,\n },\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelopes.recipients.update_many(envelope_id=\"\", data=[\n {\n \"id\": 8894.57,\n },\n ])\n\n # Handle response\n print(res)" } ] } }, "/envelope/recipient/delete": { "post": { "operationId": "envelope-recipient-delete", "summary": "Delete envelope recipient", "description": "Delete an envelope recipient", "tags": [ "Envelope Recipients" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "recipientId": { "type": "number" } }, "required": [ "recipientId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "envelopes.recipients", "x-speakeasy-name-override": "delete", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelopes.recipients.delete({\n recipientId: 4834.93,\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelopes.Recipients.Delete(ctx, operations.EnvelopeRecipientDeleteRequest{\n RecipientID: 4834.93,\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelopes.recipients.delete(recipient_id=4834.93)\n\n # Handle response\n print(res)" } ] } }, "/envelope/recipient/{recipientId}/reject": { "post": { "operationId": "envelope-recipient-rejectOnBehalfOf", "summary": "Reject envelope recipient on behalf of", "description": "Records a rejection on behalf of a recipient. Use this when a recipient has declined to sign outside of the platform. The rejection is flagged as external in the document audit log. By default the action is attributed to the API user; supply `actAsEmail` to attribute it to a specific team member.", "tags": [ "Envelope Recipients" ], "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "recipientId", "description": "The ID of the recipient to reject the document on behalf of.", "schema": { "type": "number" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "reason": { "type": "string", "minLength": 1 }, "actAsEmail": { "type": "string", "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$" } }, "required": [ "envelopeId", "reason" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "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", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] }, "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "signingOrder", "rejectionReason", "fields" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelopeRecipients.envelopeRecipientRejectOnBehalfOf({\n recipientId: 51.94,\n requestBody: {\n envelopeId: \"\",\n reason: \"\",\n },\n });\n\n console.log(result);\n}\n\nrun();" } ] } }, "/envelope/field/{fieldId}": { "get": { "operationId": "envelope-field-get", "summary": "Get envelope field", "description": "Returns an envelope field given an ID", "tags": [ "Envelope Fields" ], "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "fieldId", "schema": { "type": "number" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "envelopes.fields", "x-speakeasy-name-override": "get", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelopes.fields.get({\n fieldId: 6981.76,\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelopes.Fields.Get(ctx, 6981.76)\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelopes.fields.get(field_id=6981.76)\n\n # Handle response\n print(res)" } ] } }, "/envelope/field/create-many": { "post": { "operationId": "envelope-field-createMany", "summary": "Create envelope fields", "description": "Create multiple fields for an envelope", "tags": [ "Envelope Fields" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "data": { "type": "array", "items": { "anyOf": [ { "allOf": [ { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SIGNATURE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "type" ], "default": { "type": "signature", "fontSize": 18, "overflow": "auto" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FREE_SIGNATURE" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INITIALS" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "initials" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "initials", "fontSize": 12, "textAlign": "left" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NAME" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "name" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "name", "fontSize": 12, "textAlign": "left" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "EMAIL" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "email", "fontSize": 12, "textAlign": "left", "overflow": "auto" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "date", "fontSize": 12, "textAlign": "left", "overflow": "auto" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEXT" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "default": { "type": "text", "fontSize": 12, "textAlign": "left", "label": "", "placeholder": "", "text": "", "required": false, "readOnly": false } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NUMBER" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "default": { "type": "number", "fontSize": 12, "textAlign": "left", "label": "", "placeholder": "", "required": false, "readOnly": false } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RADIO" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ], "default": { "type": "radio", "fontSize": 12, "values": [ { "id": 1, "checked": false, "value": "" } ], "required": false, "readOnly": false, "direction": "vertical" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CHECKBOX" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ], "default": { "type": "checkbox", "fontSize": 12, "values": [ { "id": 1, "checked": false, "value": "" } ], "validationRule": "", "validationLength": 0, "required": false, "readOnly": false, "direction": "vertical" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DROPDOWN" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ], "default": { "type": "dropdown", "fontSize": 12, "values": [ { "value": "Option 1" } ], "defaultValue": "", "required": false, "readOnly": false } } }, "required": [ "type" ] } ] }, { "type": "object", "properties": { "recipientId": { "type": "number" }, "envelopeItemId": { "type": "string" } }, "required": [ "recipientId" ] }, { "type": "object", "properties": { "page": { "type": "number", "minimum": 1 }, "positionX": { "type": "number", "minimum": 0, "maximum": 100 }, "positionY": { "type": "number", "minimum": 0, "maximum": 100 }, "width": { "type": "number", "minimum": 0, "maximum": 100 }, "height": { "type": "number", "minimum": 0, "maximum": 100 } }, "required": [ "page", "positionX", "positionY", "width", "height" ] } ] }, { "allOf": [ { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SIGNATURE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "type" ], "default": { "type": "signature", "fontSize": 18, "overflow": "auto" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FREE_SIGNATURE" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INITIALS" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "initials" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "initials", "fontSize": 12, "textAlign": "left" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NAME" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "name" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "name", "fontSize": 12, "textAlign": "left" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "EMAIL" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "email", "fontSize": 12, "textAlign": "left", "overflow": "auto" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "date", "fontSize": 12, "textAlign": "left", "overflow": "auto" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEXT" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "default": { "type": "text", "fontSize": 12, "textAlign": "left", "label": "", "placeholder": "", "text": "", "required": false, "readOnly": false } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NUMBER" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "default": { "type": "number", "fontSize": 12, "textAlign": "left", "label": "", "placeholder": "", "required": false, "readOnly": false } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RADIO" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ], "default": { "type": "radio", "fontSize": 12, "values": [ { "id": 1, "checked": false, "value": "" } ], "required": false, "readOnly": false, "direction": "vertical" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CHECKBOX" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ], "default": { "type": "checkbox", "fontSize": 12, "values": [ { "id": 1, "checked": false, "value": "" } ], "validationRule": "", "validationLength": 0, "required": false, "readOnly": false, "direction": "vertical" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DROPDOWN" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ], "default": { "type": "dropdown", "fontSize": 12, "values": [ { "value": "Option 1" } ], "defaultValue": "", "required": false, "readOnly": false } } }, "required": [ "type" ] } ] }, { "type": "object", "properties": { "recipientId": { "type": "number" }, "envelopeItemId": { "type": "string" } }, "required": [ "recipientId" ] }, { "type": "object", "properties": { "placeholder": { "type": "string" }, "width": { "type": "number", "minimum": 0, "maximum": 100 }, "height": { "type": "number", "minimum": 0, "maximum": 100 }, "matchAll": { "type": "boolean" } }, "required": [ "placeholder" ] } ] } ] } } }, "required": [ "envelopeId", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "envelopes.fields", "x-speakeasy-name-override": "createMany", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelopes.fields.createMany({\n envelopeId: \"\",\n data: [],\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelopes.Fields.CreateMany(ctx, operations.EnvelopeFieldCreateManyRequest{\n EnvelopeID: \"\",\n Data: []operations.EnvelopeFieldCreateManyDataUnion{},\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelopes.fields.create_many(envelope_id=\"\", data=[])\n\n # Handle response\n print(res)" } ] } }, "/envelope/field/update-many": { "post": { "operationId": "envelope-field-updateMany", "summary": "Update envelope fields", "description": "Update multiple envelope fields for an envelope", "tags": [ "Envelope Fields" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "data": { "type": "array", "items": { "allOf": [ { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SIGNATURE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "type" ], "default": { "type": "signature", "fontSize": 18, "overflow": "auto" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FREE_SIGNATURE" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INITIALS" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "initials" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "initials", "fontSize": 12, "textAlign": "left" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NAME" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "name" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "name", "fontSize": 12, "textAlign": "left" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "EMAIL" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "email", "fontSize": 12, "textAlign": "left", "overflow": "auto" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "date", "fontSize": 12, "textAlign": "left", "overflow": "auto" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEXT" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "default": { "type": "text", "fontSize": 12, "textAlign": "left", "label": "", "placeholder": "", "text": "", "required": false, "readOnly": false } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NUMBER" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "default": { "type": "number", "fontSize": 12, "textAlign": "left", "label": "", "placeholder": "", "required": false, "readOnly": false } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RADIO" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ], "default": { "type": "radio", "fontSize": 12, "values": [ { "id": 1, "checked": false, "value": "" } ], "required": false, "readOnly": false, "direction": "vertical" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CHECKBOX" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ], "default": { "type": "checkbox", "fontSize": 12, "values": [ { "id": 1, "checked": false, "value": "" } ], "validationRule": "", "validationLength": 0, "required": false, "readOnly": false, "direction": "vertical" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DROPDOWN" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ], "default": { "type": "dropdown", "fontSize": 12, "values": [ { "value": "Option 1" } ], "defaultValue": "", "required": false, "readOnly": false } } }, "required": [ "type" ] } ] }, { "type": "object", "properties": { "id": { "type": "number" }, "envelopeItemId": { "type": "string" } }, "required": [ "id" ] }, { "type": "object", "properties": { "page": { "type": "number", "minimum": 1 }, "positionX": { "type": "number", "minimum": 0, "maximum": 100 }, "positionY": { "type": "number", "minimum": 0, "maximum": 100 }, "width": { "type": "number", "minimum": 0, "maximum": 100 }, "height": { "type": "number", "minimum": 0, "maximum": 100 } } } ] } } }, "required": [ "envelopeId", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "envelopes.fields", "x-speakeasy-name-override": "updateMany", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelopes.fields.updateMany({\n envelopeId: \"\",\n data: [],\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelopes.Fields.UpdateMany(ctx, operations.EnvelopeFieldUpdateManyRequest{\n EnvelopeID: \"\",\n Data: []operations.EnvelopeFieldUpdateManyDataUnion{},\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelopes.fields.update_many(envelope_id=\"\", data=[])\n\n # Handle response\n print(res)" } ] } }, "/envelope/field/delete": { "post": { "operationId": "envelope-field-delete", "summary": "Delete envelope field", "description": "Delete an envelope field", "tags": [ "Envelope Fields" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fieldId": { "type": "number" } }, "required": [ "fieldId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "envelopes.fields", "x-speakeasy-name-override": "delete", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelopes.fields.delete({\n fieldId: 2481.37,\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelopes.Fields.Delete(ctx, operations.EnvelopeFieldDeleteRequest{\n FieldID: 2481.37,\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelopes.fields.delete(field_id=2481.37)\n\n # Handle response\n print(res)" } ] } }, "/envelope": { "get": { "operationId": "envelope-find", "summary": "Find envelopes", "description": "Find envelopes based on search criteria", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "parameters": [ { "in": "query", "name": "query", "description": "The search query.", "schema": { "type": "string" } }, { "in": "query", "name": "page", "description": "The pagination page number, starts at 1.", "schema": { "type": "number", "minimum": 1 } }, { "in": "query", "name": "perPage", "description": "The number of items per page.", "schema": { "type": "number", "minimum": 1, "maximum": 100 } }, { "in": "query", "name": "type", "description": "Filter envelopes by type (DOCUMENT or TEMPLATE).", "schema": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE" ] } }, { "in": "query", "name": "templateId", "description": "Filter envelopes by the template ID used to create it.", "schema": { "type": "number" } }, { "in": "query", "name": "source", "description": "Filter envelopes by how it was created.", "schema": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE", "TEMPLATE_DIRECT_LINK" ] } }, { "in": "query", "name": "status", "description": "Filter envelopes by the current status.", "schema": { "type": "string", "enum": [ "DRAFT", "PENDING", "COMPLETED", "REJECTED", "CANCELLED" ] } }, { "in": "query", "name": "hasExpiredRecipients", "description": "Filter for envelopes that have at least one recipient whose signing link has expired.", "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "in": "query", "name": "folderId", "description": "Filter envelopes by folder ID.", "schema": { "type": "string" } }, { "in": "query", "name": "orderByColumn", "schema": { "type": "string", "enum": [ "createdAt" ] } }, { "in": "query", "name": "orderByDirection", "description": "Sort direction.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "internalVersion": { "type": "number" }, "type": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE" ] }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "COMPLETED", "REJECTED", "CANCELLED" ] }, "source": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE", "TEMPLATE_DIRECT_LINK" ] }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "templateType": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "ORGANISATION" ] }, "id": { "type": "string" }, "secondaryId": { "type": "string" }, "externalId": { "type": [ "string", "null" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "completedAt": { "type": [ "string", "null" ] }, "deletedAt": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "authOptions": { "type": [ "object", "null" ], "properties": { "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } } }, "required": [ "globalAccessAuth", "globalActionAuth" ] }, "formValues": { "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "publicTitle": { "type": "string" }, "publicDescription": { "type": "string" }, "userId": { "type": "number" }, "teamId": { "type": "number" }, "folderId": { "type": [ "string", "null" ] }, "templateId": { "type": [ "number", "null" ] }, "user": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "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", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "signingOrder", "rejectionReason" ] } }, "team": { "type": [ "object", "null" ], "properties": { "id": { "type": "number" }, "url": { "type": "string" } }, "required": [ "id", "url" ] } }, "required": [ "internalVersion", "type", "status", "source", "visibility", "templateType", "id", "secondaryId", "externalId", "createdAt", "updatedAt", "completedAt", "deletedAt", "title", "authOptions", "formValues", "publicTitle", "publicDescription", "userId", "teamId", "folderId", "templateId", "user", "recipients", "team" ] } }, "count": { "type": "number" }, "currentPage": { "type": "number" }, "perPage": { "type": "number" }, "totalPages": { "type": "number" } }, "required": [ "data", "count", "currentPage", "perPage", "totalPages" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelope.envelopeFind({});\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelope.EnvelopeFind(ctx, operations.EnvelopeFindRequest{})\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "import documenso_sdk\nfrom documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelope.envelope_find(order_by_direction=documenso_sdk.EnvelopeFindOrderByDirection.DESC)\n\n # Handle response\n print(res)" } ] } }, "/envelope/{envelopeId}/audit-log": { "get": { "operationId": "envelope-auditLog-find", "summary": "Get envelope audit logs", "description": "Find audit logs based on a search criteria", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "envelopeId", "description": "Envelope ID", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "page", "description": "The pagination page number, starts at 1.", "schema": { "type": "number", "minimum": 1 } }, { "in": "query", "name": "perPage", "description": "The number of items per page.", "schema": { "type": "number", "minimum": 1, "maximum": 100 } }, { "in": "query", "name": "orderByColumn", "schema": { "type": "string", "enum": [ "createdAt" ] } }, { "in": "query", "name": "orderByDirection", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string" }, "envelopeId": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "userId": { "type": [ "number", "null" ] }, "userAgent": { "type": [ "string", "null" ] }, "ipAddress": { "type": [ "string", "null" ] } }, "required": [ "id", "createdAt", "envelopeId" ] }, { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ENVELOPE_ITEM_CREATED" ] }, "data": { "type": "object", "properties": { "envelopeItemId": { "type": "string" }, "envelopeItemTitle": { "type": "string" } }, "required": [ "envelopeItemId", "envelopeItemTitle" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ENVELOPE_ITEM_DELETED" ] }, "data": { "type": "object", "properties": { "envelopeItemId": { "type": "string" }, "envelopeItemTitle": { "type": "string" } }, "required": [ "envelopeItemId", "envelopeItemTitle" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ENVELOPE_ITEM_UPDATED" ] }, "data": { "type": "object", "properties": { "envelopeItemId": { "type": "string" }, "changes": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "field", "from", "to" ] } } }, "required": [ "envelopeItemId", "changes" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ENVELOPE_ITEM_PDF_REPLACED" ] }, "data": { "type": "object", "properties": { "envelopeItemId": { "type": "string" }, "envelopeItemTitle": { "type": "string" } }, "required": [ "envelopeItemId", "envelopeItemTitle" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "EMAIL_SENT" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "emailType": { "type": "string", "enum": [ "SIGNING_REQUEST", "VIEW_REQUEST", "APPROVE_REQUEST", "ASSISTING_REQUEST", "CC", "DOCUMENT_COMPLETED", "REMINDER" ] }, "isResending": { "type": "boolean" } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "emailType", "isResending" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_COMPLETED" ] }, "data": { "type": "object", "properties": { "transactionId": { "type": "string" } }, "required": [ "transactionId" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_CREATED" ] }, "data": { "type": "object", "properties": { "title": { "type": "string" }, "source": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEMPLATE" ] }, "templateId": { "type": "number" } }, "required": [ "type", "templateId" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEMPLATE_DIRECT_LINK" ] }, "templateId": { "type": "number" }, "directRecipientEmail": { "type": "string", "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$" } }, "required": [ "type", "templateId", "directRecipientEmail" ] } ] } }, "required": [ "title" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_DELETED" ] }, "data": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SOFT", "HARD" ] } }, "required": [ "type" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_CANCELLED" ] }, "data": { "type": "object", "properties": { "reason": { "type": "string" } } } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_MOVED_TO_TEAM" ] }, "data": { "type": "object", "properties": { "movedByUserId": { "type": "number" }, "fromPersonalAccount": { "type": "boolean" }, "toTeamId": { "type": "number" } }, "required": [ "movedByUserId", "fromPersonalAccount", "toTeamId" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_DELEGATED_OWNER_CREATED" ] }, "data": { "type": "object", "properties": { "delegatedOwnerName": { "type": [ "string", "null" ] }, "delegatedOwnerEmail": { "type": "string" }, "teamName": { "type": "string" } }, "required": [ "delegatedOwnerName", "delegatedOwnerEmail", "teamName" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_FIELDS_AUTO_INSERTED" ] }, "data": { "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "number" }, "fieldType": { "type": "string", "enum": [ "SIGNATURE", "FREE_SIGNATURE", "INITIALS", "NAME", "EMAIL", "DATE", "TEXT", "NUMBER", "RADIO", "CHECKBOX", "DROPDOWN" ] }, "recipientId": { "type": "number" } }, "required": [ "fieldId", "fieldType", "recipientId" ] } } }, "required": [ "fields" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_FIELD_INSERTED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "fieldId": { "type": "string" }, "field": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INITIALS" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "EMAIL" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATE" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NAME" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEXT" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "SIGNATURE" ] }, { "type": "string", "enum": [ "FREE_SIGNATURE" ] } ] }, "data": { "type": "string" } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RADIO" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CHECKBOX" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DROPDOWN" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NUMBER" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ] } ] }, "fieldSecurity": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "fieldId", "field" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_FIELD_UNINSERTED" ] }, "data": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "SIGNATURE", "FREE_SIGNATURE", "INITIALS", "NAME", "EMAIL", "DATE", "TEXT", "NUMBER", "RADIO", "CHECKBOX", "DROPDOWN" ] }, "fieldId": { "type": "string" } }, "required": [ "field", "fieldId" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_FIELD_PREFILLED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "fieldId": { "type": "string" }, "field": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INITIALS" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "EMAIL" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATE" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NAME" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEXT" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "SIGNATURE" ] }, { "type": "string", "enum": [ "FREE_SIGNATURE" ] } ] }, "data": { "type": "string" } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RADIO" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CHECKBOX" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DROPDOWN" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NUMBER" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ] } ] }, "fieldSecurity": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "fieldId", "field" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_VISIBILITY_UPDATED" ] }, "data": { "type": "object", "properties": { "from": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "to": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "from", "to" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_GLOBAL_AUTH_ACCESS_UPDATED" ] }, "data": { "type": "object", "properties": { "from": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "to": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "from", "to" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_GLOBAL_AUTH_ACTION_UPDATED" ] }, "data": { "type": "object", "properties": { "from": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "to": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "from", "to" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_META_UPDATED" ] }, "data": { "type": "object", "properties": { "changes": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "DATE_FORMAT" ] }, { "type": "string", "enum": [ "MESSAGE" ] }, { "type": "string", "enum": [ "REDIRECT_URL" ] }, { "type": "string", "enum": [ "SUBJECT" ] }, { "type": "string", "enum": [ "TIMEZONE" ] }, { "type": "string", "enum": [ "EMAIL_ID" ] }, { "type": "string", "enum": [ "EMAIL_REPLY_TO" ] }, { "type": "string", "enum": [ "EMAIL_SETTINGS" ] } ] }, "from": { "type": [ "string", "null" ] }, "to": { "type": [ "string", "null" ] } }, "required": [ "type", "from", "to" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "PASSWORD" ] } }, "required": [ "type" ] } ] } } }, "required": [ "changes" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_OPENED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "accessAuth" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_VIEWED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "accessAuth" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_RECIPIENT_COMPLETED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "actionAuth" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_RECIPIENT_REJECTED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "reason": { "type": "string" }, "isExternal": { "type": "boolean" }, "onBehalfOfUserEmail": { "type": "string" }, "onBehalfOfUserName": { "type": [ "string", "null" ] } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "reason" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_ACCESS_AUTH_2FA_REQUESTED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" } }, "required": [ "recipientEmail", "recipientName", "recipientId" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_ACCESS_AUTH_2FA_VALIDATED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" } }, "required": [ "recipientEmail", "recipientName", "recipientId" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_ACCESS_AUTH_2FA_FAILED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" } }, "required": [ "recipientEmail", "recipientName", "recipientId" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_SENT" ] }, "data": { "type": "object" } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_TITLE_UPDATED" ] }, "data": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "from", "to" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_EXTERNAL_ID_UPDATED" ] }, "data": { "type": "object", "properties": { "from": { "type": [ "string", "null" ] }, "to": { "type": [ "string", "null" ] } } } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FIELD_CREATED" ] }, "data": { "type": "object", "properties": { "fieldId": { "type": "string" }, "fieldRecipientEmail": { "type": "string" }, "fieldRecipientId": { "type": "number" }, "fieldType": { "type": "string" } }, "required": [ "fieldId", "fieldRecipientEmail", "fieldRecipientId", "fieldType" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FIELD_DELETED" ] }, "data": { "type": "object", "properties": { "fieldId": { "type": "string" }, "fieldRecipientEmail": { "type": "string" }, "fieldRecipientId": { "type": "number" }, "fieldType": { "type": "string" } }, "required": [ "fieldId", "fieldRecipientEmail", "fieldRecipientId", "fieldType" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FIELD_UPDATED" ] }, "data": { "type": "object", "properties": { "fieldId": { "type": "string" }, "fieldRecipientEmail": { "type": "string" }, "fieldRecipientId": { "type": "number" }, "fieldType": { "type": "string" }, "changes": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DIMENSION" ] }, "from": { "type": "object", "properties": { "width": { "type": "number" }, "height": { "type": "number" } }, "required": [ "width", "height" ] }, "to": { "type": "object", "properties": { "width": { "type": "number" }, "height": { "type": "number" } }, "required": [ "width", "height" ] } }, "required": [ "type", "from", "to" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "POSITION" ] }, "from": { "type": "object", "properties": { "page": { "type": "number" }, "positionX": { "type": "number" }, "positionY": { "type": "number" } }, "required": [ "page", "positionX", "positionY" ] }, "to": { "type": "object", "properties": { "page": { "type": "number" }, "positionX": { "type": "number" }, "positionY": { "type": "number" } }, "required": [ "page", "positionX", "positionY" ] } }, "required": [ "type", "from", "to" ] } ] } } }, "required": [ "fieldId", "fieldRecipientEmail", "fieldRecipientId", "fieldType", "changes" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RECIPIENT_CREATED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "accessAuth", "actionAuth" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RECIPIENT_UPDATED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "changes": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "from": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "to": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "enum": [ "ACTION_AUTH" ] } }, "required": [ "from", "to", "type" ] }, { "type": "object", "properties": { "from": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "to": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "enum": [ "ACCESS_AUTH" ] } }, "required": [ "from", "to", "type" ] }, { "type": "object", "properties": { "from": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "to": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "enum": [ "NAME" ] } }, "required": [ "from", "to", "type" ] }, { "type": "object", "properties": { "from": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "to": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "enum": [ "ROLE" ] } }, "required": [ "from", "to", "type" ] }, { "type": "object", "properties": { "from": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "to": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "enum": [ "EMAIL" ] } }, "required": [ "from", "to", "type" ] } ] } } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "changes" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RECIPIENT_DELETED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_RECIPIENT_EXPIRED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" } }, "required": [ "recipientEmail", "recipientName", "recipientId" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_RECIPIENT_CSC_AUTHENTICATED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "providerId": { "type": "string" }, "credentialId": { "type": "string" }, "signatureAlgorithm": { "type": "string" }, "digestAlgorithm": { "type": "string" } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "providerId", "credentialId", "signatureAlgorithm", "digestAlgorithm" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_RECIPIENT_CSC_AUTHENTICATION_FAILED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "providerId": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "providerId", "reason" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_RECIPIENT_CSC_SIGN_REQUESTED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "providerId": { "type": "string" }, "credentialId": { "type": "string" }, "sessionId": { "type": "string" }, "numSignatures": { "type": "number" } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "providerId", "credentialId", "sessionId", "numSignatures" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_RECIPIENT_CSC_AUTHORIZED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "providerId": { "type": "string" }, "credentialId": { "type": "string" }, "sessionId": { "type": "string" }, "sadExpiresAt": { "type": "string" } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "providerId", "credentialId", "sessionId", "sadExpiresAt" ] } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_RECIPIENT_CSC_SIGNED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "providerId": { "type": "string" }, "credentialId": { "type": "string" }, "sessionId": { "type": "string" }, "numItemsSigned": { "type": "number" }, "signatureAlgorithm": { "type": "string" }, "digestAlgorithm": { "type": "string" } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "providerId", "credentialId", "sessionId", "numItemsSigned", "signatureAlgorithm", "digestAlgorithm" ] } }, "required": [ "type", "data" ] } ] } ] } }, "count": { "type": "number" }, "currentPage": { "type": "number" }, "perPage": { "type": "number" }, "totalPages": { "type": "number" } }, "required": [ "data", "count", "currentPage", "perPage", "totalPages" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelope.envelopeAuditLogFind({\n envelopeId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelope.EnvelopeAuditLogFind(ctx, operations.EnvelopeAuditLogFindRequest{\n EnvelopeID: \"\",\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelope.envelope_audit_log_find(envelope_id=\"\")\n\n # Handle response\n print(res)" } ] } }, "/envelope/{envelopeId}/audit-log/download": { "get": { "operationId": "envelope-auditLog-downloadPdf", "summary": "Download envelope audit log PDF", "description": "Download the audit log for a document as a PDF.", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "envelopeId", "description": "The ID of the envelope to download the audit log for.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "headers": { "Content-Type": { "schema": { "type": "string", "enum": [ "application/pdf" ] }, "required": true } }, "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelope.envelopeAuditLogDownloadPdf({\n envelopeId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" } ] } }, "/envelope/{envelopeId}/certificate/download": { "get": { "operationId": "envelope-certificate-downloadPdf", "summary": "Download envelope certificate PDF", "description": "Download the signing certificate for a completed document as a PDF.", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "envelopeId", "description": "The ID of the envelope to download the certificate for.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "headers": { "Content-Type": { "schema": { "type": "string", "enum": [ "application/pdf" ] }, "required": true } }, "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelope.envelopeCertificateDownloadPdf({\n envelopeId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" } ] } }, "/envelope/{envelopeId}": { "get": { "operationId": "envelope-get", "summary": "Get envelope", "description": "Returns an envelope given an ID", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "envelopeId", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "internalVersion": { "type": "number" }, "type": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE" ] }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "COMPLETED", "REJECTED", "CANCELLED" ] }, "source": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE", "TEMPLATE_DIRECT_LINK" ] }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "templateType": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "ORGANISATION" ] }, "id": { "type": "string" }, "secondaryId": { "type": "string" }, "externalId": { "type": [ "string", "null" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "completedAt": { "type": [ "string", "null" ] }, "deletedAt": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "authOptions": { "type": [ "object", "null" ], "properties": { "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } } }, "required": [ "globalAccessAuth", "globalActionAuth" ] }, "formValues": { "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "publicTitle": { "type": "string" }, "publicDescription": { "type": "string" }, "userId": { "type": "number" }, "teamId": { "type": "number" }, "folderId": { "type": [ "string", "null" ] }, "templateId": { "type": [ "number", "null" ] }, "documentMeta": { "type": "object", "properties": { "signingOrder": { "type": "string", "enum": [ "PARALLEL", "SEQUENTIAL" ] }, "distributionMethod": { "type": "string", "enum": [ "EMAIL", "NONE" ] }, "id": { "type": "string" }, "subject": { "type": [ "string", "null" ] }, "message": { "type": [ "string", "null" ] }, "timezone": { "type": [ "string", "null" ] }, "dateFormat": { "type": [ "string", "null" ], "x-speakeasy-enums": [ "YyyyMMddHhMmA", "YyyyMMdd", "DdMMSlashYyyy", "DdMMDashYyyy", "MmDdSlashYyyy", "YyMMdd", "MmmmDdCommaYyyy", "EeeeMmmmDdCommaYyyy", "DdMMSlashYyyyHhMmA", "DdMMSlashYyyyHHmm", "DdMMDashYyyyHhMmA", "DdMMDashYyyyHHmm", "MmDdSlashYyyyHhMmA", "MmDdSlashYyyyHHmm", "DdDotMmDotYyyy", "DdDotMmDotYyyyHHmm", "YyyyMMddHHmm", "YyMMddHhMmA", "YyMMddHHmm", "YyyyMMddHHmmss", "MmmmDdCommaYyyyHhMmA", "MmmmDdCommaYyyyHHmm", "EeeeMmmmDdCommaYyyyHhMmA", "EeeeMmmmDdCommaYyyyHHmm", "Iso8601Full" ] }, "redirectUrl": { "type": [ "string", "null" ] }, "typedSignatureEnabled": { "type": "boolean" }, "uploadSignatureEnabled": { "type": "boolean" }, "drawSignatureEnabled": { "type": "boolean" }, "allowDictateNextSigner": { "type": "boolean" }, "language": { "type": "string" }, "emailSettings": { "type": [ "object", "null" ], "properties": { "recipientSigningRequest": { "type": "boolean", "default": true }, "recipientRemoved": { "type": "boolean", "default": true }, "recipientSigned": { "type": "boolean", "default": true }, "documentPending": { "type": "boolean", "default": true }, "documentCompleted": { "type": "boolean", "default": true }, "documentDeleted": { "type": "boolean", "default": true }, "ownerDocumentCompleted": { "type": "boolean", "default": true }, "ownerRecipientExpired": { "type": "boolean", "default": true }, "ownerDocumentCreated": { "type": "boolean", "default": true } }, "required": [ "recipientSigningRequest", "recipientRemoved", "recipientSigned", "documentPending", "documentCompleted", "documentDeleted", "ownerDocumentCompleted", "ownerRecipientExpired", "ownerDocumentCreated" ], "default": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true } }, "emailId": { "type": [ "string", "null" ] }, "emailReplyTo": { "type": [ "string", "null" ] }, "envelopeExpirationPeriod": { "nullable": true, "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month", "year" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] } }, "required": [ "signingOrder", "distributionMethod", "id", "subject", "message", "timezone", "dateFormat", "redirectUrl", "typedSignatureEnabled", "uploadSignatureEnabled", "drawSignatureEnabled", "allowDictateNextSigner", "language", "emailSettings", "emailId", "emailReplyTo", "envelopeExpirationPeriod" ] }, "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", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } }, "envelopeItems": { "type": "array", "items": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "documentDataId": { "type": "string" }, "id": { "type": "string" }, "title": { "type": "string" }, "order": { "type": "number" } }, "required": [ "envelopeId", "documentDataId", "id", "title", "order" ] } }, "directLink": { "type": [ "object", "null" ], "properties": { "directTemplateRecipientId": { "type": "number" }, "enabled": { "type": "boolean" }, "id": { "type": "string" }, "token": { "type": "string" } }, "required": [ "directTemplateRecipientId", "enabled", "id", "token" ] }, "team": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" } }, "required": [ "id", "url" ] }, "user": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "email" ] } }, "required": [ "internalVersion", "type", "status", "source", "visibility", "templateType", "id", "secondaryId", "externalId", "createdAt", "updatedAt", "completedAt", "deletedAt", "title", "authOptions", "formValues", "publicTitle", "publicDescription", "userId", "teamId", "folderId", "templateId", "documentMeta", "recipients", "fields", "envelopeItems", "directLink", "team", "user" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "envelopes", "x-speakeasy-name-override": "get", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelopes.get({\n envelopeId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelopes.Get(ctx, \"\")\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelopes.get(envelope_id=\"\")\n\n # Handle response\n print(res)" } ] } }, "/envelope/get-many": { "post": { "operationId": "envelope-getMany", "summary": "Get multiple envelopes", "description": "Retrieve multiple envelopes by their IDs", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "envelopeId" ] }, "ids": { "type": "array", "items": { "type": "string" }, "minItems": 1, "maxItems": 20 } }, "required": [ "type", "ids" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "documentId" ] }, "ids": { "type": "array", "items": { "type": "number" }, "minItems": 1, "maxItems": 20 } }, "required": [ "type", "ids" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "templateId" ] }, "ids": { "type": "array", "items": { "type": "number" }, "minItems": 1, "maxItems": 20 } }, "required": [ "type", "ids" ] } ] } }, "required": [ "ids" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "internalVersion": { "type": "number" }, "type": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE" ] }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "COMPLETED", "REJECTED", "CANCELLED" ] }, "source": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE", "TEMPLATE_DIRECT_LINK" ] }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "templateType": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "ORGANISATION" ] }, "id": { "type": "string" }, "secondaryId": { "type": "string" }, "externalId": { "type": [ "string", "null" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "completedAt": { "type": [ "string", "null" ] }, "deletedAt": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "authOptions": { "type": [ "object", "null" ], "properties": { "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } } }, "required": [ "globalAccessAuth", "globalActionAuth" ] }, "formValues": { "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "publicTitle": { "type": "string" }, "publicDescription": { "type": "string" }, "userId": { "type": "number" }, "teamId": { "type": "number" }, "folderId": { "type": [ "string", "null" ] }, "templateId": { "type": [ "number", "null" ] }, "documentMeta": { "type": "object", "properties": { "signingOrder": { "type": "string", "enum": [ "PARALLEL", "SEQUENTIAL" ] }, "distributionMethod": { "type": "string", "enum": [ "EMAIL", "NONE" ] }, "id": { "type": "string" }, "subject": { "type": [ "string", "null" ] }, "message": { "type": [ "string", "null" ] }, "timezone": { "type": [ "string", "null" ] }, "dateFormat": { "type": [ "string", "null" ], "x-speakeasy-enums": [ "YyyyMMddHhMmA", "YyyyMMdd", "DdMMSlashYyyy", "DdMMDashYyyy", "MmDdSlashYyyy", "YyMMdd", "MmmmDdCommaYyyy", "EeeeMmmmDdCommaYyyy", "DdMMSlashYyyyHhMmA", "DdMMSlashYyyyHHmm", "DdMMDashYyyyHhMmA", "DdMMDashYyyyHHmm", "MmDdSlashYyyyHhMmA", "MmDdSlashYyyyHHmm", "DdDotMmDotYyyy", "DdDotMmDotYyyyHHmm", "YyyyMMddHHmm", "YyMMddHhMmA", "YyMMddHHmm", "YyyyMMddHHmmss", "MmmmDdCommaYyyyHhMmA", "MmmmDdCommaYyyyHHmm", "EeeeMmmmDdCommaYyyyHhMmA", "EeeeMmmmDdCommaYyyyHHmm", "Iso8601Full" ] }, "redirectUrl": { "type": [ "string", "null" ] }, "typedSignatureEnabled": { "type": "boolean" }, "uploadSignatureEnabled": { "type": "boolean" }, "drawSignatureEnabled": { "type": "boolean" }, "allowDictateNextSigner": { "type": "boolean" }, "language": { "type": "string" }, "emailSettings": { "type": [ "object", "null" ], "properties": { "recipientSigningRequest": { "type": "boolean", "default": true }, "recipientRemoved": { "type": "boolean", "default": true }, "recipientSigned": { "type": "boolean", "default": true }, "documentPending": { "type": "boolean", "default": true }, "documentCompleted": { "type": "boolean", "default": true }, "documentDeleted": { "type": "boolean", "default": true }, "ownerDocumentCompleted": { "type": "boolean", "default": true }, "ownerRecipientExpired": { "type": "boolean", "default": true }, "ownerDocumentCreated": { "type": "boolean", "default": true } }, "required": [ "recipientSigningRequest", "recipientRemoved", "recipientSigned", "documentPending", "documentCompleted", "documentDeleted", "ownerDocumentCompleted", "ownerRecipientExpired", "ownerDocumentCreated" ], "default": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true } }, "emailId": { "type": [ "string", "null" ] }, "emailReplyTo": { "type": [ "string", "null" ] }, "envelopeExpirationPeriod": { "nullable": true, "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month", "year" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] } }, "required": [ "signingOrder", "distributionMethod", "id", "subject", "message", "timezone", "dateFormat", "redirectUrl", "typedSignatureEnabled", "uploadSignatureEnabled", "drawSignatureEnabled", "allowDictateNextSigner", "language", "emailSettings", "emailId", "emailReplyTo", "envelopeExpirationPeriod" ] }, "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", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } }, "envelopeItems": { "type": "array", "items": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "documentDataId": { "type": "string" }, "id": { "type": "string" }, "title": { "type": "string" }, "order": { "type": "number" } }, "required": [ "envelopeId", "documentDataId", "id", "title", "order" ] } }, "directLink": { "type": [ "object", "null" ], "properties": { "directTemplateRecipientId": { "type": "number" }, "enabled": { "type": "boolean" }, "id": { "type": "string" }, "token": { "type": "string" } }, "required": [ "directTemplateRecipientId", "enabled", "id", "token" ] }, "team": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" } }, "required": [ "id", "url" ] }, "user": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "email" ] } }, "required": [ "internalVersion", "type", "status", "source", "visibility", "templateType", "id", "secondaryId", "externalId", "createdAt", "updatedAt", "completedAt", "deletedAt", "title", "authOptions", "formValues", "publicTitle", "publicDescription", "userId", "teamId", "folderId", "templateId", "documentMeta", "recipients", "fields", "envelopeItems", "directLink", "team", "user" ] } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelope.envelopeGetMany({\n ids: {\n type: \"envelopeId\",\n ids: [],\n },\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelope.EnvelopeGetMany(ctx, operations.EnvelopeGetManyRequest{\n Ids: operations.CreateIdsIdsEnvelopeID(\n operations.IdsEnvelopeID{\n Type: operations.TypeEnvelopeIDEnvelopeID,\n Ids: []string{},\n },\n ),\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "import documenso_sdk\nfrom documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelope.envelope_get_many(ids={\n \"type\": documenso_sdk.TypeEnvelopeID.ENVELOPE_ID,\n \"ids\": [],\n })\n\n # Handle response\n print(res)" } ] } }, "/envelope/create": { "post": { "operationId": "envelope-create", "summary": "Create envelope", "description": "Create an envelope using form data.", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "type": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE" ] }, "delegatedDocumentOwner": { "type": "string", "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$" }, "externalId": { "type": "string", "maxLength": 255 }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } }, "formValues": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "folderId": { "type": "string" }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "email": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": "string", "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$", "maxLength": 254 } ] }, "name": { "type": "string", "maxLength": 255 }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "signingOrder": { "type": "number" }, "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] }, "default": [] }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] }, "default": [] }, "fields": { "type": "array", "items": { "allOf": [ { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SIGNATURE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "type" ], "default": { "type": "signature", "fontSize": 18, "overflow": "auto" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FREE_SIGNATURE" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INITIALS" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "initials" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "initials", "fontSize": 12, "textAlign": "left" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NAME" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "name" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "name", "fontSize": 12, "textAlign": "left" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "EMAIL" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "email", "fontSize": 12, "textAlign": "left", "overflow": "auto" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "date", "fontSize": 12, "textAlign": "left", "overflow": "auto" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEXT" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "default": { "type": "text", "fontSize": 12, "textAlign": "left", "label": "", "placeholder": "", "text": "", "required": false, "readOnly": false } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NUMBER" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "default": { "type": "number", "fontSize": 12, "textAlign": "left", "label": "", "placeholder": "", "required": false, "readOnly": false } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RADIO" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ], "default": { "type": "radio", "fontSize": 12, "values": [ { "id": 1, "checked": false, "value": "" } ], "required": false, "readOnly": false, "direction": "vertical" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CHECKBOX" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ], "default": { "type": "checkbox", "fontSize": 12, "values": [ { "id": 1, "checked": false, "value": "" } ], "validationRule": "", "validationLength": 0, "required": false, "readOnly": false, "direction": "vertical" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DROPDOWN" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ], "default": { "type": "dropdown", "fontSize": 12, "values": [ { "value": "Option 1" } ], "defaultValue": "", "required": false, "readOnly": false } } }, "required": [ "type" ] } ] }, { "type": "object", "properties": { "identifier": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "page": { "type": "number", "minimum": 1 }, "positionX": { "type": "number", "minimum": 0, "maximum": 100 }, "positionY": { "type": "number", "minimum": 0, "maximum": 100 }, "width": { "type": "number", "minimum": 0, "maximum": 100 }, "height": { "type": "number", "minimum": 0, "maximum": 100 } }, "required": [ "page", "positionX", "positionY", "width", "height" ] } ] } } }, "required": [ "email", "name", "role" ] } }, "meta": { "type": "object", "properties": { "subject": { "type": "string", "maxLength": 254 }, "message": { "type": "string", "maxLength": 5000 }, "timezone": { "type": "string" }, "dateFormat": { "type": "string", "enum": [ "yyyy-MM-dd hh:mm a", "yyyy-MM-dd", "dd/MM/yyyy", "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", "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" ], "x-speakeasy-enums": [ "YyyyMMddHhMmA", "YyyyMMdd", "DdMMSlashYyyy", "DdMMDashYyyy", "MmDdSlashYyyy", "YyMMdd", "MmmmDdCommaYyyy", "EeeeMmmmDdCommaYyyy", "DdMMSlashYyyyHhMmA", "DdMMSlashYyyyHHmm", "DdMMDashYyyyHhMmA", "DdMMDashYyyyHHmm", "MmDdSlashYyyyHhMmA", "MmDdSlashYyyyHHmm", "DdDotMmDotYyyy", "DdDotMmDotYyyyHHmm", "YyyyMMddHHmm", "YyMMddHhMmA", "YyMMddHHmm", "YyyyMMddHHmmss", "MmmmDdCommaYyyyHhMmA", "MmmmDdCommaYyyyHHmm", "EeeeMmmmDdCommaYyyyHhMmA", "EeeeMmmmDdCommaYyyyHHmm", "Iso8601Full" ] }, "distributionMethod": { "type": "string", "enum": [ "EMAIL", "NONE" ] }, "signingOrder": { "type": "string", "enum": [ "PARALLEL", "SEQUENTIAL" ] }, "allowDictateNextSigner": { "type": "boolean" }, "redirectUrl": { "type": "string" }, "language": { "type": "string", "enum": [ "de", "en", "fr", "es", "it", "nl", "pl", "pt-BR", "ja", "ko", "zh" ] }, "typedSignatureEnabled": { "type": "boolean" }, "uploadSignatureEnabled": { "type": "boolean" }, "drawSignatureEnabled": { "type": "boolean" }, "emailId": { "type": [ "string", "null" ] }, "emailReplyTo": { "type": [ "string", "null" ], "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$" }, "emailSettings": { "type": [ "object", "null" ], "properties": { "recipientSigningRequest": { "type": "boolean", "default": true }, "recipientRemoved": { "type": "boolean", "default": true }, "recipientSigned": { "type": "boolean", "default": true }, "documentPending": { "type": "boolean", "default": true }, "documentCompleted": { "type": "boolean", "default": true }, "documentDeleted": { "type": "boolean", "default": true }, "ownerDocumentCompleted": { "type": "boolean", "default": true }, "ownerRecipientExpired": { "type": "boolean", "default": true }, "ownerDocumentCreated": { "type": "boolean", "default": true } }, "default": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true } }, "envelopeExpirationPeriod": { "nullable": true, "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month", "year" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] }, "reminderSettings": { "type": [ "object", "null" ], "properties": { "sendAfter": { "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] }, "repeatEvery": { "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] } }, "required": [ "sendAfter", "repeatEvery" ] } } }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "data": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": [ "link" ], "default": "link" } }, "required": [ "label", "data" ] } } }, "required": [ "title", "type" ] }, "files": { "type": "array", "items": { "type": "string", "contentMediaType": "application/octet-stream" } } }, "required": [ "payload" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "envelopes", "x-speakeasy-name-override": "create", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelopes.create({\n payload: {\n title: \"\",\n type: \"TEMPLATE\",\n },\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelopes.Create(ctx, operations.EnvelopeCreateRequest{\n Payload: operations.EnvelopeCreatePayload{\n Title: \"\",\n Type: operations.EnvelopeCreateTypeTemplate,\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "import documenso_sdk\nfrom documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelopes.create(payload={\n \"title\": \"\",\n \"type\": documenso_sdk.EnvelopeCreateType.TEMPLATE,\n })\n\n # Handle response\n print(res)" } ] } }, "/envelope/use": { "post": { "operationId": "envelope-use", "summary": "Use envelope", "description": "Create a document envelope from a template envelope. Upload custom files to replace the template PDFs and map them to specific envelope items using identifiers.", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "externalId": { "type": "string" }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "email": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": "string", "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$", "maxLength": 254 } ] }, "name": { "type": "string", "maxLength": 255 }, "signingOrder": { "type": "number" } }, "required": [ "id", "email" ] } }, "distributeDocument": { "type": "boolean" }, "customDocumentData": { "type": "array", "items": { "type": "object", "properties": { "identifier": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "envelopeItemId": { "type": "string" } }, "required": [ "identifier", "envelopeItemId" ] } }, "folderId": { "type": "string" }, "prefillFields": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "id": { "type": "number" } }, "required": [ "id" ] }, { "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" ] } ] } ] } }, "override": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "subject": { "type": "string", "maxLength": 254 }, "message": { "type": "string", "maxLength": 5000 }, "timezone": { "type": "string" }, "dateFormat": { "type": "string", "enum": [ "yyyy-MM-dd hh:mm a", "yyyy-MM-dd", "dd/MM/yyyy", "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", "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" ], "x-speakeasy-enums": [ "YyyyMMddHhMmA", "YyyyMMdd", "DdMMSlashYyyy", "DdMMDashYyyy", "MmDdSlashYyyy", "YyMMdd", "MmmmDdCommaYyyy", "EeeeMmmmDdCommaYyyy", "DdMMSlashYyyyHhMmA", "DdMMSlashYyyyHHmm", "DdMMDashYyyyHhMmA", "DdMMDashYyyyHHmm", "MmDdSlashYyyyHhMmA", "MmDdSlashYyyyHHmm", "DdDotMmDotYyyy", "DdDotMmDotYyyyHHmm", "YyyyMMddHHmm", "YyMMddHhMmA", "YyMMddHHmm", "YyyyMMddHHmmss", "MmmmDdCommaYyyyHhMmA", "MmmmDdCommaYyyyHHmm", "EeeeMmmmDdCommaYyyyHhMmA", "EeeeMmmmDdCommaYyyyHHmm", "Iso8601Full" ] }, "redirectUrl": { "type": "string" }, "distributionMethod": { "type": "string", "enum": [ "EMAIL", "NONE" ] }, "emailSettings": { "type": "object", "properties": { "recipientSigningRequest": { "type": "boolean", "default": true }, "recipientRemoved": { "type": "boolean", "default": true }, "recipientSigned": { "type": "boolean", "default": true }, "documentPending": { "type": "boolean", "default": true }, "documentCompleted": { "type": "boolean", "default": true }, "documentDeleted": { "type": "boolean", "default": true }, "ownerDocumentCompleted": { "type": "boolean", "default": true }, "ownerRecipientExpired": { "type": "boolean", "default": true }, "ownerDocumentCreated": { "type": "boolean", "default": true } }, "default": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true } }, "language": { "type": "string", "enum": [ "de", "en", "fr", "es", "it", "nl", "pl", "pt-BR", "ja", "ko", "zh" ] }, "typedSignatureEnabled": { "type": "boolean" }, "uploadSignatureEnabled": { "type": "boolean" }, "drawSignatureEnabled": { "type": "boolean" }, "allowDictateNextSigner": { "type": "boolean" }, "envelopeExpirationPeriod": { "nullable": true, "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month", "year" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] } } }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "data": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": [ "link" ], "default": "link" } }, "required": [ "label", "data" ] } }, "formValues": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } } }, "required": [ "envelopeId" ] }, "files": { "type": "array", "items": { "type": "string", "contentMediaType": "application/octet-stream" } } }, "required": [ "payload" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "email": { "type": "string" }, "token": { "type": "string" }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "signingOrder": { "type": [ "number", "null" ] }, "signingUrl": { "type": "string" } }, "required": [ "id", "name", "email", "token", "role", "signingOrder", "signingUrl" ] } } }, "required": [ "id", "recipients" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "envelopes", "x-speakeasy-name-override": "use", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelopes.use({\n payload: {\n envelopeId: \"\",\n },\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelopes.Use(ctx, operations.EnvelopeUseRequest{\n Payload: operations.EnvelopeUsePayload{\n EnvelopeID: \"\",\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelopes.use(payload={\n \"envelope_id\": \"\",\n })\n\n # Handle response\n print(res)" } ] } }, "/envelope/update": { "post": { "operationId": "envelope-update", "summary": "Update envelope", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "data": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "externalId": { "type": [ "string", "null" ], "maxLength": 255 }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } }, "folderId": { "type": [ "string", "null" ] }, "templateType": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "ORGANISATION" ] } } }, "meta": { "type": "object", "properties": { "subject": { "type": "string", "maxLength": 254 }, "message": { "type": "string", "maxLength": 5000 }, "timezone": { "type": "string" }, "dateFormat": { "type": "string", "enum": [ "yyyy-MM-dd hh:mm a", "yyyy-MM-dd", "dd/MM/yyyy", "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", "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" ], "x-speakeasy-enums": [ "YyyyMMddHhMmA", "YyyyMMdd", "DdMMSlashYyyy", "DdMMDashYyyy", "MmDdSlashYyyy", "YyMMdd", "MmmmDdCommaYyyy", "EeeeMmmmDdCommaYyyy", "DdMMSlashYyyyHhMmA", "DdMMSlashYyyyHHmm", "DdMMDashYyyyHhMmA", "DdMMDashYyyyHHmm", "MmDdSlashYyyyHhMmA", "MmDdSlashYyyyHHmm", "DdDotMmDotYyyy", "DdDotMmDotYyyyHHmm", "YyyyMMddHHmm", "YyMMddHhMmA", "YyMMddHHmm", "YyyyMMddHHmmss", "MmmmDdCommaYyyyHhMmA", "MmmmDdCommaYyyyHHmm", "EeeeMmmmDdCommaYyyyHhMmA", "EeeeMmmmDdCommaYyyyHHmm", "Iso8601Full" ] }, "distributionMethod": { "type": "string", "enum": [ "EMAIL", "NONE" ] }, "signingOrder": { "type": "string", "enum": [ "PARALLEL", "SEQUENTIAL" ] }, "allowDictateNextSigner": { "type": "boolean" }, "redirectUrl": { "type": "string" }, "language": { "type": "string", "enum": [ "de", "en", "fr", "es", "it", "nl", "pl", "pt-BR", "ja", "ko", "zh" ] }, "typedSignatureEnabled": { "type": "boolean" }, "uploadSignatureEnabled": { "type": "boolean" }, "drawSignatureEnabled": { "type": "boolean" }, "emailId": { "type": [ "string", "null" ] }, "emailReplyTo": { "type": [ "string", "null" ], "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$" }, "emailSettings": { "type": [ "object", "null" ], "properties": { "recipientSigningRequest": { "type": "boolean", "default": true }, "recipientRemoved": { "type": "boolean", "default": true }, "recipientSigned": { "type": "boolean", "default": true }, "documentPending": { "type": "boolean", "default": true }, "documentCompleted": { "type": "boolean", "default": true }, "documentDeleted": { "type": "boolean", "default": true }, "ownerDocumentCompleted": { "type": "boolean", "default": true }, "ownerRecipientExpired": { "type": "boolean", "default": true }, "ownerDocumentCreated": { "type": "boolean", "default": true } }, "default": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true } }, "envelopeExpirationPeriod": { "nullable": true, "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month", "year" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] }, "reminderSettings": { "type": [ "object", "null" ], "properties": { "sendAfter": { "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] }, "repeatEvery": { "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] } }, "required": [ "sendAfter", "repeatEvery" ] } } } }, "required": [ "envelopeId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "internalVersion": { "type": "number" }, "type": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE" ] }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "COMPLETED", "REJECTED", "CANCELLED" ] }, "source": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE", "TEMPLATE_DIRECT_LINK" ] }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "templateType": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "ORGANISATION" ] }, "id": { "type": "string" }, "secondaryId": { "type": "string" }, "externalId": { "type": [ "string", "null" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "completedAt": { "type": [ "string", "null" ] }, "deletedAt": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "authOptions": { "type": [ "object", "null" ], "properties": { "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } } }, "required": [ "globalAccessAuth", "globalActionAuth" ] }, "formValues": { "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "publicTitle": { "type": "string" }, "publicDescription": { "type": "string" }, "userId": { "type": "number" }, "teamId": { "type": "number" }, "folderId": { "type": [ "string", "null" ] } }, "required": [ "internalVersion", "type", "status", "source", "visibility", "templateType", "id", "secondaryId", "externalId", "createdAt", "updatedAt", "completedAt", "deletedAt", "title", "authOptions", "formValues", "publicTitle", "publicDescription", "userId", "teamId", "folderId" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "envelopes", "x-speakeasy-name-override": "update", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelopes.update({\n envelopeId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelopes.Update(ctx, operations.EnvelopeUpdateRequest{\n EnvelopeID: \"\",\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelopes.update(envelope_id=\"\")\n\n # Handle response\n print(res)" } ] } }, "/envelope/delete": { "post": { "operationId": "envelope-delete", "summary": "Delete envelope", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" } }, "required": [ "envelopeId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "envelopes", "x-speakeasy-name-override": "delete", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelopes.delete({\n envelopeId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelopes.Delete(ctx, operations.EnvelopeDeleteRequest{\n EnvelopeID: \"\",\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelopes.delete(envelope_id=\"\")\n\n # Handle response\n print(res)" } ] } }, "/envelope/cancel": { "post": { "operationId": "envelope-cancel", "summary": "Cancel envelope", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "envelopeId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelope.envelopeCancel({\n envelopeId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" } ] } }, "/envelope/duplicate": { "post": { "operationId": "envelope-duplicate", "summary": "Duplicate envelope", "description": "Duplicate an envelope with all its settings", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string", "minLength": 1 }, "includeRecipients": { "type": "boolean", "default": true }, "includeFields": { "type": "boolean", "default": true } }, "required": [ "envelopeId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "envelopes", "x-speakeasy-name-override": "duplicate", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelopes.duplicate({\n envelopeId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelopes.Duplicate(ctx, operations.EnvelopeDuplicateRequest{\n EnvelopeID: \"\",\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelopes.duplicate(envelope_id=\"\")\n\n # Handle response\n print(res)" } ] } }, "/envelope/distribute": { "post": { "operationId": "envelope-distribute", "summary": "Distribute envelope", "description": "Send the envelope to recipients based on your distribution method", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "meta": { "type": "object", "properties": { "subject": { "type": "string", "maxLength": 254 }, "message": { "type": "string", "maxLength": 5000 }, "timezone": { "type": "string" }, "dateFormat": { "type": "string", "enum": [ "yyyy-MM-dd hh:mm a", "yyyy-MM-dd", "dd/MM/yyyy", "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", "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" ], "x-speakeasy-enums": [ "YyyyMMddHhMmA", "YyyyMMdd", "DdMMSlashYyyy", "DdMMDashYyyy", "MmDdSlashYyyy", "YyMMdd", "MmmmDdCommaYyyy", "EeeeMmmmDdCommaYyyy", "DdMMSlashYyyyHhMmA", "DdMMSlashYyyyHHmm", "DdMMDashYyyyHhMmA", "DdMMDashYyyyHHmm", "MmDdSlashYyyyHhMmA", "MmDdSlashYyyyHHmm", "DdDotMmDotYyyy", "DdDotMmDotYyyyHHmm", "YyyyMMddHHmm", "YyMMddHhMmA", "YyMMddHHmm", "YyyyMMddHHmmss", "MmmmDdCommaYyyyHhMmA", "MmmmDdCommaYyyyHHmm", "EeeeMmmmDdCommaYyyyHhMmA", "EeeeMmmmDdCommaYyyyHHmm", "Iso8601Full" ] }, "distributionMethod": { "type": "string", "enum": [ "EMAIL", "NONE" ] }, "redirectUrl": { "type": "string" }, "language": { "type": "string", "enum": [ "de", "en", "fr", "es", "it", "nl", "pl", "pt-BR", "ja", "ko", "zh" ] }, "emailId": { "type": [ "string", "null" ] }, "emailReplyTo": { "type": [ "string", "null" ], "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$" }, "emailSettings": { "type": [ "object", "null" ], "properties": { "recipientSigningRequest": { "type": "boolean", "default": true }, "recipientRemoved": { "type": "boolean", "default": true }, "recipientSigned": { "type": "boolean", "default": true }, "documentPending": { "type": "boolean", "default": true }, "documentCompleted": { "type": "boolean", "default": true }, "documentDeleted": { "type": "boolean", "default": true }, "ownerDocumentCompleted": { "type": "boolean", "default": true }, "ownerRecipientExpired": { "type": "boolean", "default": true }, "ownerDocumentCreated": { "type": "boolean", "default": true } }, "default": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true } } } } }, "required": [ "envelopeId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "id": { "type": "string" }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "email": { "type": "string" }, "token": { "type": "string" }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "signingOrder": { "type": [ "number", "null" ] }, "signingUrl": { "type": "string" } }, "required": [ "id", "name", "email", "token", "role", "signingOrder", "signingUrl" ] } } }, "required": [ "success", "id", "recipients" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "envelopes", "x-speakeasy-name-override": "distribute", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelopes.distribute({\n envelopeId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelopes.Distribute(ctx, operations.EnvelopeDistributeRequest{\n EnvelopeID: \"\",\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelopes.distribute(envelope_id=\"\")\n\n # Handle response\n print(res)" } ] } }, "/envelope/redistribute": { "post": { "operationId": "envelope-redistribute", "summary": "Redistribute envelope", "description": "Redistribute the envelope to the provided recipients who have not actioned the envelope. Will use the distribution method set in the envelope. This also refreshes the signing-link expiration for the targeted unsigned recipients, renewing any expired links.", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "recipients": { "type": "array", "items": { "type": "number" }, "minItems": 1 } }, "required": [ "envelopeId", "recipients" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "id": { "type": "string" }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "email": { "type": "string" }, "token": { "type": "string" }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "signingOrder": { "type": [ "number", "null" ] }, "signingUrl": { "type": "string" } }, "required": [ "id", "name", "email", "token", "role", "signingOrder", "signingUrl" ] } } }, "required": [ "success", "id", "recipients" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "envelopes", "x-speakeasy-name-override": "redistribute", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.envelopes.redistribute({\n envelopeId: \"\",\n recipients: [],\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Envelopes.Redistribute(ctx, operations.EnvelopeRedistributeRequest{\n EnvelopeID: \"\",\n Recipients: []float64{},\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.envelopes.redistribute(envelope_id=\"\", recipients=[])\n\n # Handle response\n print(res)" } ] } }, "/document/{documentId}": { "get": { "operationId": "document-get", "summary": "Get document", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Returns a document given an ID", "tags": [ "Document" ], "security": [ { "apiKey": [] } ], "deprecated": true, "parameters": [ { "in": "path", "name": "documentId", "schema": { "type": "number" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "COMPLETED", "REJECTED", "CANCELLED" ] }, "source": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE", "TEMPLATE_DIRECT_LINK" ] }, "id": { "type": "number" }, "externalId": { "type": [ "string", "null" ] }, "userId": { "type": "number" }, "authOptions": { "type": [ "object", "null" ], "properties": { "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } } }, "required": [ "globalAccessAuth", "globalActionAuth" ] }, "formValues": { "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "title": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "completedAt": { "type": [ "string", "null" ] }, "deletedAt": { "type": [ "string", "null" ] }, "teamId": { "type": "number" }, "folderId": { "type": [ "string", "null" ] }, "envelopeId": { "type": "string" }, "internalVersion": { "type": "number" }, "templateId": { "type": [ "number", "null" ] }, "documentDataId": { "type": "string", "default": "" }, "documentData": { "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" ] }, "documentMeta": { "type": "object", "properties": { "signingOrder": { "type": "string", "enum": [ "PARALLEL", "SEQUENTIAL" ] }, "distributionMethod": { "type": "string", "enum": [ "EMAIL", "NONE" ] }, "id": { "type": "string" }, "subject": { "type": [ "string", "null" ] }, "message": { "type": [ "string", "null" ] }, "timezone": { "type": [ "string", "null" ] }, "dateFormat": { "type": [ "string", "null" ], "x-speakeasy-enums": [ "YyyyMMddHhMmA", "YyyyMMdd", "DdMMSlashYyyy", "DdMMDashYyyy", "MmDdSlashYyyy", "YyMMdd", "MmmmDdCommaYyyy", "EeeeMmmmDdCommaYyyy", "DdMMSlashYyyyHhMmA", "DdMMSlashYyyyHHmm", "DdMMDashYyyyHhMmA", "DdMMDashYyyyHHmm", "MmDdSlashYyyyHhMmA", "MmDdSlashYyyyHHmm", "DdDotMmDotYyyy", "DdDotMmDotYyyyHHmm", "YyyyMMddHHmm", "YyMMddHhMmA", "YyMMddHHmm", "YyyyMMddHHmmss", "MmmmDdCommaYyyyHhMmA", "MmmmDdCommaYyyyHHmm", "EeeeMmmmDdCommaYyyyHhMmA", "EeeeMmmmDdCommaYyyyHHmm", "Iso8601Full" ] }, "redirectUrl": { "type": [ "string", "null" ] }, "typedSignatureEnabled": { "type": "boolean" }, "uploadSignatureEnabled": { "type": "boolean" }, "drawSignatureEnabled": { "type": "boolean" }, "allowDictateNextSigner": { "type": "boolean" }, "language": { "type": "string" }, "emailSettings": { "type": [ "object", "null" ], "properties": { "recipientSigningRequest": { "type": "boolean", "default": true }, "recipientRemoved": { "type": "boolean", "default": true }, "recipientSigned": { "type": "boolean", "default": true }, "documentPending": { "type": "boolean", "default": true }, "documentCompleted": { "type": "boolean", "default": true }, "documentDeleted": { "type": "boolean", "default": true }, "ownerDocumentCompleted": { "type": "boolean", "default": true }, "ownerRecipientExpired": { "type": "boolean", "default": true }, "ownerDocumentCreated": { "type": "boolean", "default": true } }, "required": [ "recipientSigningRequest", "recipientRemoved", "recipientSigned", "documentPending", "documentCompleted", "documentDeleted", "ownerDocumentCompleted", "ownerRecipientExpired", "ownerDocumentCreated" ], "default": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true } }, "emailId": { "type": [ "string", "null" ] }, "emailReplyTo": { "type": [ "string", "null" ] }, "envelopeExpirationPeriod": { "nullable": true, "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month", "year" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] }, "reminderSettings": { "type": [ "object", "null" ], "properties": { "sendAfter": { "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] }, "repeatEvery": { "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] } }, "required": [ "sendAfter", "repeatEvery" ] }, "password": { "type": [ "string", "null" ], "default": null }, "documentId": { "type": "number", "default": -1 } }, "required": [ "signingOrder", "distributionMethod", "id", "subject", "message", "timezone", "dateFormat", "redirectUrl", "typedSignatureEnabled", "uploadSignatureEnabled", "drawSignatureEnabled", "allowDictateNextSigner", "language", "emailSettings", "emailId", "emailReplyTo", "envelopeExpirationPeriod", "reminderSettings", "password" ] }, "envelopeItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "envelopeId": { "type": "string" } }, "required": [ "id", "envelopeId" ] } }, "folder": { "type": [ "object", "null" ], "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", "null" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "type", "visibility", "userId", "teamId", "pinned", "parentId", "createdAt", "updatedAt" ] }, "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", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } } }, "required": [ "visibility", "status", "source", "id", "externalId", "userId", "authOptions", "formValues", "title", "createdAt", "updatedAt", "completedAt", "deletedAt", "teamId", "folderId", "envelopeId", "internalVersion", "documentDataId", "documentData", "documentMeta", "envelopeItems", "folder", "recipients", "fields" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "documents", "x-speakeasy-name-override": "get", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Documents.Get(ctx, 6150.61)\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.documents.get(document_id=6150.61)\n\n # Handle response\n print(res)" } ] } }, "/document/get-many": { "post": { "operationId": "document-getMany", "summary": "Get multiple documents", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Retrieve multiple documents by their IDs", "tags": [ "Document" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "documentIds": { "type": "array", "items": { "type": "number" }, "minItems": 1 } }, "required": [ "documentIds" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "COMPLETED", "REJECTED", "CANCELLED" ] }, "source": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE", "TEMPLATE_DIRECT_LINK" ] }, "id": { "type": "number" }, "externalId": { "type": [ "string", "null" ] }, "userId": { "type": "number" }, "authOptions": { "type": [ "object", "null" ], "properties": { "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } } }, "required": [ "globalAccessAuth", "globalActionAuth" ] }, "formValues": { "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "title": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "completedAt": { "type": [ "string", "null" ] }, "deletedAt": { "type": [ "string", "null" ] }, "teamId": { "type": "number" }, "folderId": { "type": [ "string", "null" ] }, "useLegacyFieldInsertion": { "type": "boolean" }, "envelopeId": { "type": "string" }, "internalVersion": { "type": "number" }, "documentDataId": { "type": "string", "default": "" }, "templateId": { "type": [ "number", "null" ] }, "user": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": [ "string", "null" ] }, "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", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "signingOrder", "rejectionReason" ] } }, "team": { "type": [ "object", "null" ], "properties": { "id": { "type": "number" }, "url": { "type": "string" } }, "required": [ "id", "url" ] } }, "required": [ "visibility", "status", "source", "id", "externalId", "userId", "authOptions", "formValues", "title", "createdAt", "updatedAt", "completedAt", "deletedAt", "teamId", "folderId", "useLegacyFieldInsertion", "envelopeId", "internalVersion", "documentDataId", "user", "recipients", "team" ] } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Document.DocumentGetMany(ctx, operations.DocumentGetManyRequest{\n DocumentIds: []float64{},\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.document.document_get_many(document_ids=[])\n\n # Handle response\n print(res)" } ] } }, "/document": { "get": { "operationId": "document-find", "summary": "Find documents", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Find documents based on a search criteria", "tags": [ "Document" ], "security": [ { "apiKey": [] } ], "deprecated": true, "parameters": [ { "in": "query", "name": "query", "description": "The search query.", "schema": { "type": "string" } }, { "in": "query", "name": "page", "description": "The pagination page number, starts at 1.", "schema": { "type": "number", "minimum": 1 } }, { "in": "query", "name": "perPage", "description": "The number of items per page.", "schema": { "type": "number", "minimum": 1, "maximum": 100 } }, { "in": "query", "name": "templateId", "description": "Filter documents by the template ID used to create it.", "schema": { "type": "number" } }, { "in": "query", "name": "source", "description": "Filter documents by how it was created.", "schema": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE", "TEMPLATE_DIRECT_LINK" ] } }, { "in": "query", "name": "status", "description": "Filter documents by the current status", "schema": { "type": "string", "enum": [ "DRAFT", "PENDING", "COMPLETED", "REJECTED", "CANCELLED" ] } }, { "in": "query", "name": "hasExpiredRecipients", "description": "Filter for documents that have at least one recipient whose signing link has expired.", "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "in": "query", "name": "folderId", "description": "Filter documents by folder ID", "schema": { "type": "string" } }, { "in": "query", "name": "orderByColumn", "schema": { "type": "string", "enum": [ "createdAt" ] } }, { "in": "query", "name": "orderByDirection", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "COMPLETED", "REJECTED", "CANCELLED" ] }, "source": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE", "TEMPLATE_DIRECT_LINK" ] }, "id": { "type": "number" }, "externalId": { "type": [ "string", "null" ] }, "userId": { "type": "number" }, "authOptions": { "type": [ "object", "null" ], "properties": { "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } } }, "required": [ "globalAccessAuth", "globalActionAuth" ] }, "formValues": { "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "title": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "completedAt": { "type": [ "string", "null" ] }, "deletedAt": { "type": [ "string", "null" ] }, "teamId": { "type": "number" }, "folderId": { "type": [ "string", "null" ] }, "useLegacyFieldInsertion": { "type": "boolean" }, "envelopeId": { "type": "string" }, "internalVersion": { "type": "number" }, "documentDataId": { "type": "string", "default": "" }, "templateId": { "type": [ "number", "null" ] }, "user": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": [ "string", "null" ] }, "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", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "signingOrder", "rejectionReason" ] } }, "team": { "type": [ "object", "null" ], "properties": { "id": { "type": "number" }, "url": { "type": "string" } }, "required": [ "id", "url" ] } }, "required": [ "visibility", "status", "source", "id", "externalId", "userId", "authOptions", "formValues", "title", "createdAt", "updatedAt", "completedAt", "deletedAt", "teamId", "folderId", "useLegacyFieldInsertion", "envelopeId", "internalVersion", "documentDataId", "user", "recipients", "team" ] } }, "count": { "type": "number" }, "currentPage": { "type": "number" }, "perPage": { "type": "number" }, "totalPages": { "type": "number" } }, "required": [ "data", "count", "currentPage", "perPage", "totalPages" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "documents", "x-speakeasy-name-override": "find", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Documents.Find(ctx, operations.DocumentFindRequest{})\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "import documenso_sdk\nfrom documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.documents.find(order_by_direction=documenso_sdk.DocumentFindOrderByDirection.DESC)\n\n # Handle response\n print(res)" } ] } }, "/document/create": { "post": { "operationId": "document-create", "summary": "Create document", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide.", "tags": [ "Document" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "externalId": { "type": "string", "maxLength": 255 }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } }, "formValues": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "folderId": { "type": "string" }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$", "minLength": 1, "maxLength": 254 }, "name": { "type": "string", "maxLength": 255 }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "signingOrder": { "type": "number" }, "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] }, "default": [] }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] }, "default": [] }, "fields": { "type": "array", "items": { "allOf": [ { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SIGNATURE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FREE_SIGNATURE" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INITIALS" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "initials" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NAME" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "name" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "EMAIL" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEXT" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NUMBER" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RADIO" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CHECKBOX" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DROPDOWN" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "type" ] } ] }, { "type": "object", "properties": { "pageNumber": { "type": "number", "minimum": 1 }, "pageX": { "type": "number", "minimum": 0 }, "pageY": { "type": "number", "minimum": 0 }, "width": { "type": "number", "minimum": 1 }, "height": { "type": "number", "minimum": 1 } }, "required": [ "pageNumber", "pageX", "pageY", "width", "height" ] } ] } } }, "required": [ "email", "name", "role" ] } }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "data": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": [ "link" ], "default": "link" } }, "required": [ "label", "data" ] } }, "meta": { "type": "object", "properties": { "subject": { "type": "string", "maxLength": 254 }, "message": { "type": "string", "maxLength": 5000 }, "timezone": { "type": "string" }, "dateFormat": { "type": "string", "enum": [ "yyyy-MM-dd hh:mm a", "yyyy-MM-dd", "dd/MM/yyyy", "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", "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" ], "x-speakeasy-enums": [ "YyyyMMddHhMmA", "YyyyMMdd", "DdMMSlashYyyy", "DdMMDashYyyy", "MmDdSlashYyyy", "YyMMdd", "MmmmDdCommaYyyy", "EeeeMmmmDdCommaYyyy", "DdMMSlashYyyyHhMmA", "DdMMSlashYyyyHHmm", "DdMMDashYyyyHhMmA", "DdMMDashYyyyHHmm", "MmDdSlashYyyyHhMmA", "MmDdSlashYyyyHHmm", "DdDotMmDotYyyy", "DdDotMmDotYyyyHHmm", "YyyyMMddHHmm", "YyMMddHhMmA", "YyMMddHHmm", "YyyyMMddHHmmss", "MmmmDdCommaYyyyHhMmA", "MmmmDdCommaYyyyHHmm", "EeeeMmmmDdCommaYyyyHhMmA", "EeeeMmmmDdCommaYyyyHHmm", "Iso8601Full" ] }, "distributionMethod": { "type": "string", "enum": [ "EMAIL", "NONE" ] }, "signingOrder": { "type": "string", "enum": [ "PARALLEL", "SEQUENTIAL" ] }, "allowDictateNextSigner": { "type": "boolean" }, "redirectUrl": { "type": "string" }, "language": { "type": "string", "enum": [ "de", "en", "fr", "es", "it", "nl", "pl", "pt-BR", "ja", "ko", "zh" ] }, "typedSignatureEnabled": { "type": "boolean" }, "uploadSignatureEnabled": { "type": "boolean" }, "drawSignatureEnabled": { "type": "boolean" }, "emailId": { "type": [ "string", "null" ] }, "emailReplyTo": { "type": [ "string", "null" ], "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$" }, "emailSettings": { "type": [ "object", "null" ], "properties": { "recipientSigningRequest": { "type": "boolean", "default": true }, "recipientRemoved": { "type": "boolean", "default": true }, "recipientSigned": { "type": "boolean", "default": true }, "documentPending": { "type": "boolean", "default": true }, "documentCompleted": { "type": "boolean", "default": true }, "documentDeleted": { "type": "boolean", "default": true }, "ownerDocumentCompleted": { "type": "boolean", "default": true }, "ownerRecipientExpired": { "type": "boolean", "default": true }, "ownerDocumentCreated": { "type": "boolean", "default": true } }, "default": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true } }, "envelopeExpirationPeriod": { "nullable": true, "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month", "year" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] }, "reminderSettings": { "type": [ "object", "null" ], "properties": { "sendAfter": { "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] }, "repeatEvery": { "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] } }, "required": [ "sendAfter", "repeatEvery" ] } } } }, "required": [ "title" ] }, "file": { "type": "string", "contentMediaType": "application/octet-stream" } }, "required": [ "payload", "file" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "id": { "type": "number" } }, "required": [ "envelopeId", "id" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "documents", "x-speakeasy-name-override": "create", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n example, fileErr := os.Open(\"example.file\")\n if fileErr != nil {\n panic(fileErr)\n }\n\n res, err := s.Documents.Create(ctx, operations.DocumentCreateRequest{\n Payload: operations.DocumentCreatePayload{\n Title: \"\",\n },\n File: operations.DocumentCreateFile{\n FileName: \"example.file\",\n Content: example,\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.documents.create(payload={\n \"title\": \"\",\n }, file={\n \"file_name\": \"example.file\",\n \"content\": open(\"example.file\", \"rb\"),\n })\n\n # Handle response\n print(res)" } ] } }, "/document/update": { "post": { "operationId": "document-update", "summary": "Update document", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide.", "tags": [ "Document" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "documentId": { "type": "number" }, "data": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "externalId": { "type": [ "string", "null" ], "maxLength": 255 }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } }, "useLegacyFieldInsertion": { "type": "boolean" }, "folderId": { "type": [ "string", "null" ] } } }, "meta": { "type": "object", "properties": { "subject": { "type": "string", "maxLength": 254 }, "message": { "type": "string", "maxLength": 5000 }, "timezone": { "type": "string" }, "dateFormat": { "type": "string", "enum": [ "yyyy-MM-dd hh:mm a", "yyyy-MM-dd", "dd/MM/yyyy", "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", "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" ], "x-speakeasy-enums": [ "YyyyMMddHhMmA", "YyyyMMdd", "DdMMSlashYyyy", "DdMMDashYyyy", "MmDdSlashYyyy", "YyMMdd", "MmmmDdCommaYyyy", "EeeeMmmmDdCommaYyyy", "DdMMSlashYyyyHhMmA", "DdMMSlashYyyyHHmm", "DdMMDashYyyyHhMmA", "DdMMDashYyyyHHmm", "MmDdSlashYyyyHhMmA", "MmDdSlashYyyyHHmm", "DdDotMmDotYyyy", "DdDotMmDotYyyyHHmm", "YyyyMMddHHmm", "YyMMddHhMmA", "YyMMddHHmm", "YyyyMMddHHmmss", "MmmmDdCommaYyyyHhMmA", "MmmmDdCommaYyyyHHmm", "EeeeMmmmDdCommaYyyyHhMmA", "EeeeMmmmDdCommaYyyyHHmm", "Iso8601Full" ] }, "distributionMethod": { "type": "string", "enum": [ "EMAIL", "NONE" ] }, "signingOrder": { "type": "string", "enum": [ "PARALLEL", "SEQUENTIAL" ] }, "allowDictateNextSigner": { "type": "boolean" }, "redirectUrl": { "type": "string" }, "language": { "type": "string", "enum": [ "de", "en", "fr", "es", "it", "nl", "pl", "pt-BR", "ja", "ko", "zh" ] }, "typedSignatureEnabled": { "type": "boolean" }, "uploadSignatureEnabled": { "type": "boolean" }, "drawSignatureEnabled": { "type": "boolean" }, "emailId": { "type": [ "string", "null" ] }, "emailReplyTo": { "type": [ "string", "null" ], "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$" }, "emailSettings": { "type": [ "object", "null" ], "properties": { "recipientSigningRequest": { "type": "boolean", "default": true }, "recipientRemoved": { "type": "boolean", "default": true }, "recipientSigned": { "type": "boolean", "default": true }, "documentPending": { "type": "boolean", "default": true }, "documentCompleted": { "type": "boolean", "default": true }, "documentDeleted": { "type": "boolean", "default": true }, "ownerDocumentCompleted": { "type": "boolean", "default": true }, "ownerRecipientExpired": { "type": "boolean", "default": true }, "ownerDocumentCreated": { "type": "boolean", "default": true } }, "default": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true } }, "envelopeExpirationPeriod": { "nullable": true, "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month", "year" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] }, "reminderSettings": { "type": [ "object", "null" ], "properties": { "sendAfter": { "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] }, "repeatEvery": { "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] } }, "required": [ "sendAfter", "repeatEvery" ] } } } }, "required": [ "documentId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "COMPLETED", "REJECTED", "CANCELLED" ] }, "source": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE", "TEMPLATE_DIRECT_LINK" ] }, "id": { "type": "number" }, "externalId": { "type": [ "string", "null" ] }, "userId": { "type": "number" }, "authOptions": { "type": [ "object", "null" ], "properties": { "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } } }, "required": [ "globalAccessAuth", "globalActionAuth" ] }, "formValues": { "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "title": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "completedAt": { "type": [ "string", "null" ] }, "deletedAt": { "type": [ "string", "null" ] }, "teamId": { "type": "number" }, "folderId": { "type": [ "string", "null" ] }, "useLegacyFieldInsertion": { "type": "boolean" }, "envelopeId": { "type": "string" }, "internalVersion": { "type": "number" }, "documentDataId": { "type": "string", "default": "" }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "visibility", "status", "source", "id", "externalId", "userId", "authOptions", "formValues", "title", "createdAt", "updatedAt", "completedAt", "deletedAt", "teamId", "folderId", "useLegacyFieldInsertion", "envelopeId", "internalVersion", "documentDataId" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "documents", "x-speakeasy-name-override": "update", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Documents.Update(ctx, operations.DocumentUpdateRequest{\n DocumentID: 3428.95,\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.documents.update(document_id=3428.95)\n\n # Handle response\n print(res)" } ] } }, "/document/delete": { "post": { "operationId": "document-delete", "summary": "Delete document", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide.", "tags": [ "Document" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "documentId": { "type": "number" } }, "required": [ "documentId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "documents", "x-speakeasy-name-override": "delete", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Documents.Delete(ctx, operations.DocumentDeleteRequest{\n DocumentID: 3963.4,\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.documents.delete(document_id=3963.4)\n\n # Handle response\n print(res)" } ] } }, "/document/duplicate": { "post": { "operationId": "document-duplicate", "summary": "Duplicate document", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide.", "tags": [ "Document" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "documentId": { "type": "number" } }, "required": [ "documentId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "documentId": { "type": "number" } }, "required": [ "id", "documentId" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "documents", "x-speakeasy-name-override": "duplicate", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Documents.Duplicate(ctx, operations.DocumentDuplicateRequest{\n DocumentID: 5285.3,\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.documents.duplicate(document_id=5285.3)\n\n # Handle response\n print(res)" } ] } }, "/document/distribute": { "post": { "operationId": "document-distribute", "summary": "Distribute document", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Send the document out to recipients based on your distribution method", "tags": [ "Document" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "documentId": { "type": "number" }, "meta": { "type": "object", "properties": { "subject": { "type": "string", "maxLength": 254 }, "message": { "type": "string", "maxLength": 5000 }, "timezone": { "type": "string" }, "dateFormat": { "type": "string", "enum": [ "yyyy-MM-dd hh:mm a", "yyyy-MM-dd", "dd/MM/yyyy", "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", "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" ], "x-speakeasy-enums": [ "YyyyMMddHhMmA", "YyyyMMdd", "DdMMSlashYyyy", "DdMMDashYyyy", "MmDdSlashYyyy", "YyMMdd", "MmmmDdCommaYyyy", "EeeeMmmmDdCommaYyyy", "DdMMSlashYyyyHhMmA", "DdMMSlashYyyyHHmm", "DdMMDashYyyyHhMmA", "DdMMDashYyyyHHmm", "MmDdSlashYyyyHhMmA", "MmDdSlashYyyyHHmm", "DdDotMmDotYyyy", "DdDotMmDotYyyyHHmm", "YyyyMMddHHmm", "YyMMddHhMmA", "YyMMddHHmm", "YyyyMMddHHmmss", "MmmmDdCommaYyyyHhMmA", "MmmmDdCommaYyyyHHmm", "EeeeMmmmDdCommaYyyyHhMmA", "EeeeMmmmDdCommaYyyyHHmm", "Iso8601Full" ] }, "distributionMethod": { "type": "string", "enum": [ "EMAIL", "NONE" ] }, "redirectUrl": { "type": "string" }, "language": { "type": "string", "enum": [ "de", "en", "fr", "es", "it", "nl", "pl", "pt-BR", "ja", "ko", "zh" ] }, "emailId": { "type": [ "string", "null" ] }, "emailReplyTo": { "type": [ "string", "null" ], "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$" }, "emailSettings": { "type": "object", "properties": { "recipientSigningRequest": { "type": "boolean", "default": true }, "recipientRemoved": { "type": "boolean", "default": true }, "recipientSigned": { "type": "boolean", "default": true }, "documentPending": { "type": "boolean", "default": true }, "documentCompleted": { "type": "boolean", "default": true }, "documentDeleted": { "type": "boolean", "default": true }, "ownerDocumentCompleted": { "type": "boolean", "default": true }, "ownerRecipientExpired": { "type": "boolean", "default": true }, "ownerDocumentCreated": { "type": "boolean", "default": true } }, "default": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true } } } } }, "required": [ "documentId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "COMPLETED", "REJECTED", "CANCELLED" ] }, "source": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE", "TEMPLATE_DIRECT_LINK" ] }, "id": { "type": "number" }, "externalId": { "type": [ "string", "null" ] }, "userId": { "type": "number" }, "authOptions": { "type": [ "object", "null" ], "properties": { "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } } }, "required": [ "globalAccessAuth", "globalActionAuth" ] }, "formValues": { "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "title": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "completedAt": { "type": [ "string", "null" ] }, "deletedAt": { "type": [ "string", "null" ] }, "teamId": { "type": "number" }, "folderId": { "type": [ "string", "null" ] }, "useLegacyFieldInsertion": { "type": "boolean" }, "envelopeId": { "type": "string" }, "internalVersion": { "type": "number" }, "documentDataId": { "type": "string", "default": "" }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "visibility", "status", "source", "id", "externalId", "userId", "authOptions", "formValues", "title", "createdAt", "updatedAt", "completedAt", "deletedAt", "teamId", "folderId", "useLegacyFieldInsertion", "envelopeId", "internalVersion", "documentDataId" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "documents", "x-speakeasy-name-override": "distribute", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Documents.Distribute(ctx, operations.DocumentDistributeRequest{\n DocumentID: 7548.74,\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.documents.distribute(document_id=7548.74)\n\n # Handle response\n print(res)" } ] } }, "/document/redistribute": { "post": { "operationId": "document-redistribute", "summary": "Redistribute document", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Redistribute the document to the provided recipients who have not actioned the document. Will use the distribution method set in the document. This also refreshes the signing-link expiration for the targeted unsigned recipients, renewing any expired links.", "tags": [ "Document" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "documentId": { "type": "number" }, "recipients": { "type": "array", "items": { "type": "number" }, "minItems": 1 } }, "required": [ "documentId", "recipients" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "documents", "x-speakeasy-name-override": "redistribute", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Documents.Redistribute(ctx, operations.DocumentRedistributeRequest{\n DocumentID: 9084.69,\n Recipients: []float64{\n 6011.8,\n 4441.56,\n 4251.15,\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.documents.redistribute(document_id=9084.69, recipients=[\n 6011.8,\n 4441.56,\n 4251.15,\n ])\n\n # Handle response\n print(res)" } ] } }, "/document/{documentId}/download": { "get": { "operationId": "document-download", "summary": "Download document", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide.", "tags": [ "Document" ], "security": [ { "apiKey": [] } ], "deprecated": true, "parameters": [ { "in": "path", "name": "documentId", "description": "The ID of the document to download.", "schema": { "type": "number" }, "required": true }, { "in": "query", "name": "version", "description": "The version of the document to download. \"signed\" returns the completed document with signatures, \"original\" returns the original uploaded document.", "schema": { "type": "string", "enum": [ "original", "signed" ], "default": "signed" } } ], "responses": { "200": { "description": "Successful response", "headers": { "Content-Type": { "schema": { "type": "string", "enum": [ "application/pdf" ] }, "required": true } }, "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "documents", "x-speakeasy-name-override": "download", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Documents.Download(ctx, 5396.97, operations.DocumentDownloadVersionSigned.ToPointer())\n if err != nil {\n log.Fatal(err)\n }\n if res.Any != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "import documenso_sdk\nfrom documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.documents.download(document_id=5396.97, version=documenso_sdk.DocumentDownloadVersion.SIGNED)\n\n # Handle response\n print(res)" } ] } }, "/document/{documentId}/download-beta": { "get": { "operationId": "document-downloadBeta", "summary": "Download document (beta)", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Get a pre-signed download URL for the original or signed version of a document", "tags": [ "Document" ], "security": [ { "apiKey": [] } ], "deprecated": true, "parameters": [ { "in": "path", "name": "documentId", "description": "The ID of the document to download.", "schema": { "type": "number" }, "required": true }, { "in": "query", "name": "version", "description": "The version of the document to download. \"signed\" returns the completed document with signatures, \"original\" returns the original uploaded document.", "schema": { "type": "string", "enum": [ "original", "signed" ], "default": "signed" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "downloadUrl": { "type": "string" }, "filename": { "type": "string" }, "contentType": { "type": "string" } }, "required": [ "downloadUrl", "filename", "contentType" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "document", "x-speakeasy-name-override": "documentDownload", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Document.DocumentDownload(ctx, 9550.11, operations.DocumentDownloadBetaVersionSigned.ToPointer())\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "import documenso_sdk\nfrom documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.document.document_download(document_id=9550.11, version=documenso_sdk.DocumentDownloadBetaVersion.SIGNED)\n\n # Handle response\n print(res)" } ] } }, "/document/create/beta": { "post": { "operationId": "document-createDocumentTemporary", "summary": "Create document", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. You will need to upload the PDF to the provided URL returned. This endpoint will be removed since we will allow direct uploads, instead of using an upload URL.", "tags": [ "Document" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "externalId": { "type": "string", "maxLength": 255 }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } }, "formValues": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "folderId": { "type": "string" }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$", "minLength": 1, "maxLength": 254 }, "name": { "type": "string", "maxLength": 255 }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "signingOrder": { "type": "number" }, "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] }, "default": [] }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] }, "default": [] }, "fields": { "type": "array", "items": { "allOf": [ { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SIGNATURE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FREE_SIGNATURE" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INITIALS" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "initials" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NAME" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "name" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "EMAIL" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEXT" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NUMBER" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RADIO" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CHECKBOX" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DROPDOWN" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "type" ] } ] }, { "type": "object", "properties": { "pageNumber": { "type": "number", "minimum": 1 }, "pageX": { "type": "number", "minimum": 0 }, "pageY": { "type": "number", "minimum": 0 }, "width": { "type": "number", "minimum": 1 }, "height": { "type": "number", "minimum": 1 } }, "required": [ "pageNumber", "pageX", "pageY", "width", "height" ] } ] } } }, "required": [ "email", "name", "role" ] } }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "data": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": [ "link" ], "default": "link" } }, "required": [ "label", "data" ] } }, "meta": { "type": "object", "properties": { "subject": { "type": "string", "maxLength": 254 }, "message": { "type": "string", "maxLength": 5000 }, "timezone": { "type": "string" }, "dateFormat": { "type": "string", "enum": [ "yyyy-MM-dd hh:mm a", "yyyy-MM-dd", "dd/MM/yyyy", "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", "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" ], "x-speakeasy-enums": [ "YyyyMMddHhMmA", "YyyyMMdd", "DdMMSlashYyyy", "DdMMDashYyyy", "MmDdSlashYyyy", "YyMMdd", "MmmmDdCommaYyyy", "EeeeMmmmDdCommaYyyy", "DdMMSlashYyyyHhMmA", "DdMMSlashYyyyHHmm", "DdMMDashYyyyHhMmA", "DdMMDashYyyyHHmm", "MmDdSlashYyyyHhMmA", "MmDdSlashYyyyHHmm", "DdDotMmDotYyyy", "DdDotMmDotYyyyHHmm", "YyyyMMddHHmm", "YyMMddHhMmA", "YyMMddHHmm", "YyyyMMddHHmmss", "MmmmDdCommaYyyyHhMmA", "MmmmDdCommaYyyyHHmm", "EeeeMmmmDdCommaYyyyHhMmA", "EeeeMmmmDdCommaYyyyHHmm", "Iso8601Full" ] }, "distributionMethod": { "type": "string", "enum": [ "EMAIL", "NONE" ] }, "signingOrder": { "type": "string", "enum": [ "PARALLEL", "SEQUENTIAL" ] }, "allowDictateNextSigner": { "type": "boolean" }, "redirectUrl": { "type": "string" }, "language": { "type": "string", "enum": [ "de", "en", "fr", "es", "it", "nl", "pl", "pt-BR", "ja", "ko", "zh" ] }, "typedSignatureEnabled": { "type": "boolean" }, "uploadSignatureEnabled": { "type": "boolean" }, "drawSignatureEnabled": { "type": "boolean" }, "emailId": { "type": [ "string", "null" ] }, "emailReplyTo": { "type": [ "string", "null" ], "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$" }, "emailSettings": { "type": [ "object", "null" ], "properties": { "recipientSigningRequest": { "type": "boolean", "default": true }, "recipientRemoved": { "type": "boolean", "default": true }, "recipientSigned": { "type": "boolean", "default": true }, "documentPending": { "type": "boolean", "default": true }, "documentCompleted": { "type": "boolean", "default": true }, "documentDeleted": { "type": "boolean", "default": true }, "ownerDocumentCompleted": { "type": "boolean", "default": true }, "ownerRecipientExpired": { "type": "boolean", "default": true }, "ownerDocumentCreated": { "type": "boolean", "default": true } }, "default": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true } }, "envelopeExpirationPeriod": { "nullable": true, "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month", "year" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] }, "reminderSettings": { "type": [ "object", "null" ], "properties": { "sendAfter": { "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] }, "repeatEvery": { "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] } }, "required": [ "sendAfter", "repeatEvery" ] } } } }, "required": [ "title" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "document": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "COMPLETED", "REJECTED", "CANCELLED" ] }, "source": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE", "TEMPLATE_DIRECT_LINK" ] }, "id": { "type": "number" }, "externalId": { "type": [ "string", "null" ] }, "userId": { "type": "number" }, "authOptions": { "type": [ "object", "null" ], "properties": { "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } } }, "required": [ "globalAccessAuth", "globalActionAuth" ] }, "formValues": { "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "title": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "completedAt": { "type": [ "string", "null" ] }, "deletedAt": { "type": [ "string", "null" ] }, "teamId": { "type": "number" }, "folderId": { "type": [ "string", "null" ] }, "envelopeId": { "type": "string" }, "internalVersion": { "type": "number" }, "templateId": { "type": [ "number", "null" ] }, "documentDataId": { "type": "string", "default": "" }, "documentData": { "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" ] }, "documentMeta": { "type": "object", "properties": { "signingOrder": { "type": "string", "enum": [ "PARALLEL", "SEQUENTIAL" ] }, "distributionMethod": { "type": "string", "enum": [ "EMAIL", "NONE" ] }, "id": { "type": "string" }, "subject": { "type": [ "string", "null" ] }, "message": { "type": [ "string", "null" ] }, "timezone": { "type": [ "string", "null" ] }, "dateFormat": { "type": [ "string", "null" ], "x-speakeasy-enums": [ "YyyyMMddHhMmA", "YyyyMMdd", "DdMMSlashYyyy", "DdMMDashYyyy", "MmDdSlashYyyy", "YyMMdd", "MmmmDdCommaYyyy", "EeeeMmmmDdCommaYyyy", "DdMMSlashYyyyHhMmA", "DdMMSlashYyyyHHmm", "DdMMDashYyyyHhMmA", "DdMMDashYyyyHHmm", "MmDdSlashYyyyHhMmA", "MmDdSlashYyyyHHmm", "DdDotMmDotYyyy", "DdDotMmDotYyyyHHmm", "YyyyMMddHHmm", "YyMMddHhMmA", "YyMMddHHmm", "YyyyMMddHHmmss", "MmmmDdCommaYyyyHhMmA", "MmmmDdCommaYyyyHHmm", "EeeeMmmmDdCommaYyyyHhMmA", "EeeeMmmmDdCommaYyyyHHmm", "Iso8601Full" ] }, "redirectUrl": { "type": [ "string", "null" ] }, "typedSignatureEnabled": { "type": "boolean" }, "uploadSignatureEnabled": { "type": "boolean" }, "drawSignatureEnabled": { "type": "boolean" }, "allowDictateNextSigner": { "type": "boolean" }, "language": { "type": "string" }, "emailSettings": { "type": [ "object", "null" ], "properties": { "recipientSigningRequest": { "type": "boolean", "default": true }, "recipientRemoved": { "type": "boolean", "default": true }, "recipientSigned": { "type": "boolean", "default": true }, "documentPending": { "type": "boolean", "default": true }, "documentCompleted": { "type": "boolean", "default": true }, "documentDeleted": { "type": "boolean", "default": true }, "ownerDocumentCompleted": { "type": "boolean", "default": true }, "ownerRecipientExpired": { "type": "boolean", "default": true }, "ownerDocumentCreated": { "type": "boolean", "default": true } }, "required": [ "recipientSigningRequest", "recipientRemoved", "recipientSigned", "documentPending", "documentCompleted", "documentDeleted", "ownerDocumentCompleted", "ownerRecipientExpired", "ownerDocumentCreated" ], "default": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true } }, "emailId": { "type": [ "string", "null" ] }, "emailReplyTo": { "type": [ "string", "null" ] }, "envelopeExpirationPeriod": { "nullable": true, "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month", "year" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] }, "reminderSettings": { "type": [ "object", "null" ], "properties": { "sendAfter": { "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] }, "repeatEvery": { "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] } }, "required": [ "sendAfter", "repeatEvery" ] }, "password": { "type": [ "string", "null" ], "default": null }, "documentId": { "type": "number", "default": -1 } }, "required": [ "signingOrder", "distributionMethod", "id", "subject", "message", "timezone", "dateFormat", "redirectUrl", "typedSignatureEnabled", "uploadSignatureEnabled", "drawSignatureEnabled", "allowDictateNextSigner", "language", "emailSettings", "emailId", "emailReplyTo", "envelopeExpirationPeriod", "reminderSettings", "password" ] }, "envelopeItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "envelopeId": { "type": "string" } }, "required": [ "id", "envelopeId" ] } }, "folder": { "type": [ "object", "null" ], "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", "null" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "type", "visibility", "userId", "teamId", "pinned", "parentId", "createdAt", "updatedAt" ] }, "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", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } } }, "required": [ "visibility", "status", "source", "id", "externalId", "userId", "authOptions", "formValues", "title", "createdAt", "updatedAt", "completedAt", "deletedAt", "teamId", "folderId", "envelopeId", "internalVersion", "documentDataId", "documentData", "documentMeta", "envelopeItems", "folder", "recipients", "fields" ] }, "uploadUrl": { "type": "string" } }, "required": [ "document", "uploadUrl" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "documents", "x-speakeasy-name-override": "createV0" } }, "/document/attachment/create": { "post": { "operationId": "document-attachment-create", "summary": "Create attachment", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Create a new attachment for a document", "tags": [ "Document" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "documentId": { "type": "number" }, "data": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "data": { "type": "string", "format": "uri" } }, "required": [ "label", "data" ] } }, "required": [ "documentId", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "documents.attachments", "x-speakeasy-name-override": "create", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Documents.Attachments.Create(ctx, operations.DocumentAttachmentCreateRequest{\n DocumentID: 7014.36,\n Data: operations.DocumentAttachmentCreateData{\n Label: \"\",\n Data: \"https://cheerful-bourgeoisie.org/\",\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.documents.attachments.create(document_id=7014.36, data={\n \"label\": \"\",\n \"data\": \"https://cheerful-bourgeoisie.org/\",\n })\n\n # Handle response\n print(res)" } ] } }, "/document/attachment/update": { "post": { "operationId": "document-attachment-update", "summary": "Update attachment", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Update an existing attachment", "tags": [ "Document" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "data": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "data": { "type": "string", "format": "uri" } }, "required": [ "label", "data" ] } }, "required": [ "id", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "documents.attachments", "x-speakeasy-name-override": "update", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Documents.Attachments.Update(ctx, operations.DocumentAttachmentUpdateRequest{\n ID: \"\",\n Data: operations.DocumentAttachmentUpdateData{\n Label: \"\",\n Data: \"https://tinted-ceramics.biz\",\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.documents.attachments.update(id=\"\", data={\n \"label\": \"\",\n \"data\": \"https://tinted-ceramics.biz\",\n })\n\n # Handle response\n print(res)" } ] } }, "/document/attachment/delete": { "post": { "operationId": "document-attachment-delete", "summary": "Delete attachment", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Delete an attachment from a document", "tags": [ "Document" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "documents.attachments", "x-speakeasy-name-override": "delete", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Documents.Attachments.Delete(ctx, operations.DocumentAttachmentDeleteRequest{\n ID: \"\",\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.documents.attachments.delete(id=\"\")\n\n # Handle response\n print(res)" } ] } }, "/document/attachment": { "get": { "operationId": "document-attachment-find", "summary": "Find attachments", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Find all attachments for a document", "tags": [ "Document" ], "security": [ { "apiKey": [] } ], "deprecated": true, "parameters": [ { "in": "query", "name": "documentId", "schema": { "type": "number" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "link" ] }, "label": { "type": "string" }, "data": { "type": "string" } }, "required": [ "id", "type", "label", "data" ] } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "documents.attachments", "x-speakeasy-name-override": "find", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Documents.Attachments.Find(ctx, 965.17)\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.documents.attachments.find(document_id=965.17)\n\n # Handle response\n print(res)" } ] } }, "/document/field/{fieldId}": { "get": { "operationId": "field-getDocumentField", "summary": "Get document field", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Returns a single field. If you want to retrieve all the fields for a document, use the \"Get Document\" endpoint.", "tags": [ "Document Fields" ], "security": [ { "apiKey": [] } ], "deprecated": true, "parameters": [ { "in": "path", "name": "fieldId", "schema": { "type": "number" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "documents.fields", "x-speakeasy-name-override": "get", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Documents.Fields.Get(ctx, 6077.81)\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.documents.fields.get(field_id=6077.81)\n\n # Handle response\n print(res)" } ] } }, "/document/field/create": { "post": { "operationId": "field-createDocumentField", "summary": "Create document field", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Create a single field for a document.", "tags": [ "Document Fields" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "documentId": { "type": "number" }, "field": { "allOf": [ { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SIGNATURE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FREE_SIGNATURE" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INITIALS" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "initials" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NAME" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "name" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "EMAIL" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEXT" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NUMBER" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RADIO" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CHECKBOX" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DROPDOWN" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "type" ] } ] }, { "type": "object", "properties": { "recipientId": { "type": "number" }, "pageNumber": { "type": "number", "minimum": 1 }, "pageX": { "type": "number", "minimum": 0 }, "pageY": { "type": "number", "minimum": 0 }, "width": { "type": "number", "minimum": 1 }, "height": { "type": "number", "minimum": 1 } }, "required": [ "recipientId", "pageNumber", "pageX", "pageY", "width", "height" ] } ] } }, "required": [ "documentId", "field" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "documents.fields", "x-speakeasy-name-override": "create", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Documents.Fields.Create(ctx, operations.FieldCreateDocumentFieldRequest{\n DocumentID: 8001.93,\n Field: operations.CreateFieldCreateDocumentFieldFieldUnionFieldCreateDocumentFieldFieldName(\n operations.FieldCreateDocumentFieldFieldName{\n Type: operations.FieldCreateDocumentFieldTypeNameRequest1Name,\n RecipientID: 2564.68,\n PageNumber: 791.77,\n PageX: 7845.22,\n PageY: 6843.16,\n Width: 3932.15,\n Height: 8879.89,\n },\n ),\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "import documenso_sdk\nfrom documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.documents.fields.create(document_id=8001.93, field={\n \"type\": documenso_sdk.FieldCreateDocumentFieldTypeNameRequest1.NAME,\n \"recipient_id\": 2564.68,\n \"page_number\": 791.77,\n \"page_x\": 7845.22,\n \"page_y\": 6843.16,\n \"width\": 3932.15,\n \"height\": 8879.89,\n })\n\n # Handle response\n print(res)" } ] } }, "/document/field/create-many": { "post": { "operationId": "field-createDocumentFields", "summary": "Create document fields", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Create multiple fields for a document.", "tags": [ "Document Fields" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "documentId": { "type": "number" }, "fields": { "type": "array", "items": { "allOf": [ { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SIGNATURE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FREE_SIGNATURE" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INITIALS" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "initials" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NAME" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "name" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "EMAIL" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEXT" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NUMBER" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RADIO" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CHECKBOX" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DROPDOWN" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "type" ] } ] }, { "type": "object", "properties": { "recipientId": { "type": "number" }, "pageNumber": { "type": "number", "minimum": 1 }, "pageX": { "type": "number", "minimum": 0 }, "pageY": { "type": "number", "minimum": 0 }, "width": { "type": "number", "minimum": 1 }, "height": { "type": "number", "minimum": 1 } }, "required": [ "recipientId", "pageNumber", "pageX", "pageY", "width", "height" ] } ] } } }, "required": [ "documentId", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } } }, "required": [ "fields" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "documents.fields", "x-speakeasy-name-override": "createMany", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Documents.Fields.CreateMany(ctx, operations.FieldCreateDocumentFieldsRequest{\n DocumentID: 6257.51,\n Fields: []operations.FieldCreateDocumentFieldsFieldUnion{\n operations.CreateFieldCreateDocumentFieldsFieldUnionFieldCreateDocumentFieldsFieldFreeSignature(\n operations.FieldCreateDocumentFieldsFieldFreeSignature{\n Type: operations.FieldCreateDocumentFieldsTypeFreeSignatureFreeSignature,\n RecipientID: 679.35,\n PageNumber: 5914.59,\n PageX: 7253.11,\n PageY: 8426.91,\n Width: 8995.55,\n Height: 9808.97,\n },\n ),\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "import documenso_sdk\nfrom documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.documents.fields.create_many(document_id=6257.51, fields=[\n {\n \"type\": documenso_sdk.FieldCreateDocumentFieldsTypeFreeSignature.FREE_SIGNATURE,\n \"recipient_id\": 679.35,\n \"page_number\": 5914.59,\n \"page_x\": 7253.11,\n \"page_y\": 8426.91,\n \"width\": 8995.55,\n \"height\": 9808.97,\n },\n ])\n\n # Handle response\n print(res)" } ] } }, "/document/field/update": { "post": { "operationId": "field-updateDocumentField", "summary": "Update document field", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Update a single field for a document.", "tags": [ "Document Fields" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "documentId": { "type": "number" }, "field": { "allOf": [ { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SIGNATURE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FREE_SIGNATURE" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INITIALS" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "initials" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NAME" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "name" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "EMAIL" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEXT" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NUMBER" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RADIO" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CHECKBOX" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DROPDOWN" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "type" ] } ] }, { "type": "object", "properties": { "id": { "type": "number" }, "pageNumber": { "type": "number", "minimum": 1 }, "pageX": { "type": "number", "minimum": 0 }, "pageY": { "type": "number", "minimum": 0 }, "width": { "type": "number", "minimum": 1 }, "height": { "type": "number", "minimum": 1 } }, "required": [ "id" ] } ] } }, "required": [ "documentId", "field" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "documents.fields", "x-speakeasy-name-override": "update", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Documents.Fields.Update(ctx, operations.FieldUpdateDocumentFieldRequest{\n DocumentID: 5956.26,\n Field: operations.CreateFieldUpdateDocumentFieldFieldUnionFieldUpdateDocumentFieldFieldFreeSignature(\n operations.FieldUpdateDocumentFieldFieldFreeSignature{\n Type: operations.FieldUpdateDocumentFieldTypeFreeSignatureFreeSignature,\n ID: 6955.16,\n },\n ),\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "import documenso_sdk\nfrom documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.documents.fields.update(document_id=5956.26, field={\n \"type\": documenso_sdk.FieldUpdateDocumentFieldTypeFreeSignature.FREE_SIGNATURE,\n \"id\": 6955.16,\n })\n\n # Handle response\n print(res)" } ] } }, "/document/field/update-many": { "post": { "operationId": "field-updateDocumentFields", "summary": "Update document fields", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Update multiple fields for a document.", "tags": [ "Document Fields" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "documentId": { "type": "number" }, "fields": { "type": "array", "items": { "allOf": [ { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SIGNATURE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FREE_SIGNATURE" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INITIALS" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "initials" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NAME" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "name" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "EMAIL" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEXT" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NUMBER" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RADIO" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CHECKBOX" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DROPDOWN" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "type" ] } ] }, { "type": "object", "properties": { "id": { "type": "number" }, "pageNumber": { "type": "number", "minimum": 1 }, "pageX": { "type": "number", "minimum": 0 }, "pageY": { "type": "number", "minimum": 0 }, "width": { "type": "number", "minimum": 1 }, "height": { "type": "number", "minimum": 1 } }, "required": [ "id" ] } ] } } }, "required": [ "documentId", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } } }, "required": [ "fields" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "documents.fields", "x-speakeasy-name-override": "updateMany", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Documents.Fields.UpdateMany(ctx, operations.FieldUpdateDocumentFieldsRequest{\n DocumentID: 9317.43,\n Fields: []operations.FieldUpdateDocumentFieldsFieldUnion{},\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.documents.fields.update_many(document_id=9317.43, fields=[])\n\n # Handle response\n print(res)" } ] } }, "/document/field/delete": { "post": { "operationId": "field-deleteDocumentField", "summary": "Delete document field", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide.", "tags": [ "Document Fields" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fieldId": { "type": "number" } }, "required": [ "fieldId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "documents.fields", "x-speakeasy-name-override": "delete", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Documents.Fields.Delete(ctx, operations.FieldDeleteDocumentFieldRequest{\n FieldID: 4748.27,\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.documents.fields.delete(field_id=4748.27)\n\n # Handle response\n print(res)" } ] } }, "/template/field/create": { "post": { "operationId": "field-createTemplateField", "summary": "Create template field", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Create a single field for a template.", "tags": [ "Template Fields" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "number" }, "field": { "allOf": [ { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SIGNATURE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FREE_SIGNATURE" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INITIALS" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "initials" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NAME" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "name" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "EMAIL" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEXT" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NUMBER" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RADIO" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CHECKBOX" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DROPDOWN" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "type" ] } ] }, { "type": "object", "properties": { "recipientId": { "type": "number" }, "pageNumber": { "type": "number", "minimum": 1 }, "pageX": { "type": "number", "minimum": 0 }, "pageY": { "type": "number", "minimum": 0 }, "width": { "type": "number", "minimum": 1 }, "height": { "type": "number", "minimum": 1 } }, "required": [ "recipientId", "pageNumber", "pageX", "pageY", "width", "height" ] } ] } }, "required": [ "templateId", "field" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "templates.fields", "x-speakeasy-name-override": "create", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Templates.Fields.Create(ctx, operations.FieldCreateTemplateFieldRequest{\n TemplateID: 1203.71,\n Field: operations.CreateFieldCreateTemplateFieldFieldUnionFieldCreateTemplateFieldFieldDate(\n operations.FieldCreateTemplateFieldFieldDate{\n Type: operations.FieldCreateTemplateFieldTypeDateRequest1Date,\n RecipientID: 2738.54,\n PageNumber: 5735.12,\n PageX: 2936.28,\n PageY: 8594.41,\n Width: 7589.39,\n Height: 3122.23,\n },\n ),\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "import documenso_sdk\nfrom documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.templates.fields.create(template_id=1203.71, field={\n \"type\": documenso_sdk.FieldCreateTemplateFieldTypeDateRequest1.DATE,\n \"recipient_id\": 2738.54,\n \"page_number\": 5735.12,\n \"page_x\": 2936.28,\n \"page_y\": 8594.41,\n \"width\": 7589.39,\n \"height\": 3122.23,\n })\n\n # Handle response\n print(res)" } ] } }, "/template/field/{fieldId}": { "get": { "operationId": "field-getTemplateField", "summary": "Get template field", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Returns a single field. If you want to retrieve all the fields for a template, use the \"Get Template\" endpoint.", "tags": [ "Template Fields" ], "security": [ { "apiKey": [] } ], "deprecated": true, "parameters": [ { "in": "path", "name": "fieldId", "schema": { "type": "number" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "templates.fields", "x-speakeasy-name-override": "get", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Templates.Fields.Get(ctx, 1152.82)\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.templates.fields.get(field_id=1152.82)\n\n # Handle response\n print(res)" } ] } }, "/template/field/create-many": { "post": { "operationId": "field-createTemplateFields", "summary": "Create template fields", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Create multiple fields for a template.", "tags": [ "Template Fields" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "number" }, "fields": { "type": "array", "items": { "allOf": [ { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SIGNATURE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FREE_SIGNATURE" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INITIALS" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "initials" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NAME" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "name" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "EMAIL" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEXT" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NUMBER" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RADIO" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CHECKBOX" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DROPDOWN" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "type" ] } ] }, { "type": "object", "properties": { "recipientId": { "type": "number" }, "pageNumber": { "type": "number", "minimum": 1 }, "pageX": { "type": "number", "minimum": 0 }, "pageY": { "type": "number", "minimum": 0 }, "width": { "type": "number", "minimum": 1 }, "height": { "type": "number", "minimum": 1 } }, "required": [ "recipientId", "pageNumber", "pageX", "pageY", "width", "height" ] } ] } } }, "required": [ "templateId", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } } }, "required": [ "fields" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "templates.fields", "x-speakeasy-name-override": "createMany", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Templates.Fields.CreateMany(ctx, operations.FieldCreateTemplateFieldsRequest{\n TemplateID: 586.2,\n Fields: []operations.FieldCreateTemplateFieldsFieldUnion{\n operations.CreateFieldCreateTemplateFieldsFieldUnionFieldCreateTemplateFieldsFieldSignature(\n operations.FieldCreateTemplateFieldsFieldSignature{\n Type: operations.FieldCreateTemplateFieldsTypeSignatureRequest1Signature,\n RecipientID: 6990.12,\n PageNumber: 3472.45,\n PageX: 4747.87,\n PageY: 1673.94,\n Width: 7215.37,\n Height: 9417.43,\n },\n ),\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "import documenso_sdk\nfrom documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.templates.fields.create_many(template_id=586.2, fields=[\n {\n \"type\": documenso_sdk.FieldCreateTemplateFieldsTypeSignatureRequest1.SIGNATURE,\n \"recipient_id\": 6990.12,\n \"page_number\": 3472.45,\n \"page_x\": 4747.87,\n \"page_y\": 1673.94,\n \"width\": 7215.37,\n \"height\": 9417.43,\n },\n ])\n\n # Handle response\n print(res)" } ] } }, "/template/field/update": { "post": { "operationId": "field-updateTemplateField", "summary": "Update template field", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Update a single field for a template.", "tags": [ "Template Fields" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "number" }, "field": { "allOf": [ { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SIGNATURE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FREE_SIGNATURE" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INITIALS" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "initials" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NAME" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "name" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "EMAIL" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEXT" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NUMBER" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RADIO" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CHECKBOX" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DROPDOWN" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "type" ] } ] }, { "type": "object", "properties": { "id": { "type": "number" }, "pageNumber": { "type": "number", "minimum": 1 }, "pageX": { "type": "number", "minimum": 0 }, "pageY": { "type": "number", "minimum": 0 }, "width": { "type": "number", "minimum": 1 }, "height": { "type": "number", "minimum": 1 } }, "required": [ "id" ] } ] } }, "required": [ "templateId", "field" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "templates.fields", "x-speakeasy-name-override": "update", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Templates.Fields.Update(ctx, operations.FieldUpdateTemplateFieldRequest{\n TemplateID: 5083.07,\n Field: operations.CreateFieldUpdateTemplateFieldFieldUnionFieldUpdateTemplateFieldFieldText(\n operations.FieldUpdateTemplateFieldFieldText{\n Type: operations.FieldUpdateTemplateFieldTypeTextRequest1Text,\n ID: 1792.29,\n },\n ),\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "import documenso_sdk\nfrom documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.templates.fields.update(template_id=5083.07, field={\n \"type\": documenso_sdk.FieldUpdateTemplateFieldTypeTextRequest1.TEXT,\n \"id\": 1792.29,\n })\n\n # Handle response\n print(res)" } ] } }, "/template/field/update-many": { "post": { "operationId": "field-updateTemplateFields", "summary": "Update template fields", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Update multiple fields for a template.", "tags": [ "Template Fields" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "number" }, "fields": { "type": "array", "items": { "allOf": [ { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SIGNATURE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FREE_SIGNATURE" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INITIALS" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "initials" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NAME" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "name" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "EMAIL" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEXT" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NUMBER" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RADIO" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CHECKBOX" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DROPDOWN" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "type" ] } ] }, { "type": "object", "properties": { "id": { "type": "number" }, "pageNumber": { "type": "number", "minimum": 1 }, "pageX": { "type": "number", "minimum": 0 }, "pageY": { "type": "number", "minimum": 0 }, "width": { "type": "number", "minimum": 1 }, "height": { "type": "number", "minimum": 1 } }, "required": [ "id" ] } ] } } }, "required": [ "templateId", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } } }, "required": [ "fields" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "templates.fields", "x-speakeasy-name-override": "updateMany", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Templates.Fields.UpdateMany(ctx, operations.FieldUpdateTemplateFieldsRequest{\n TemplateID: 3969.1,\n Fields: []operations.FieldUpdateTemplateFieldsFieldUnion{\n operations.CreateFieldUpdateTemplateFieldsFieldUnionFieldUpdateTemplateFieldsFieldDropdown(\n operations.FieldUpdateTemplateFieldsFieldDropdown{\n Type: operations.FieldUpdateTemplateFieldsTypeDropdownRequest1Dropdown,\n ID: 2460.72,\n },\n ),\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "import documenso_sdk\nfrom documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.templates.fields.update_many(template_id=3969.1, fields=[\n {\n \"type\": documenso_sdk.FieldUpdateTemplateFieldsTypeDropdownRequest1.DROPDOWN,\n \"id\": 2460.72,\n },\n ])\n\n # Handle response\n print(res)" } ] } }, "/template/field/delete": { "post": { "operationId": "field-deleteTemplateField", "summary": "Delete template field", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide.", "tags": [ "Template Fields" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fieldId": { "type": "number" } }, "required": [ "fieldId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "templates.fields", "x-speakeasy-name-override": "delete", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Templates.Fields.Delete(ctx, operations.FieldDeleteTemplateFieldRequest{\n FieldID: 7996.49,\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.templates.fields.delete(field_id=7996.49)\n\n # Handle response\n print(res)" } ] } }, "/folder": { "get": { "operationId": "folder-findFolders", "summary": "Find folders", "description": "Find folders based on a search criteria", "tags": [ "Folder" ], "security": [ { "apiKey": [] } ], "parameters": [ { "in": "query", "name": "query", "description": "The search query.", "schema": { "type": "string" } }, { "in": "query", "name": "page", "description": "The pagination page number, starts at 1.", "schema": { "type": "number", "minimum": 1 } }, { "in": "query", "name": "perPage", "description": "The number of items per page.", "schema": { "type": "number", "minimum": 1, "maximum": 100 } }, { "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "in": "query", "name": "type", "schema": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE" ] } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "userId": { "type": "number" }, "teamId": { "type": "number" }, "parentId": { "type": [ "string", "null" ] }, "pinned": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "type": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE" ] } }, "required": [ "id", "name", "userId", "teamId", "parentId", "pinned", "createdAt", "updatedAt", "visibility", "type" ] } }, "count": { "type": "number" }, "currentPage": { "type": "number" }, "perPage": { "type": "number" }, "totalPages": { "type": "number" } }, "required": [ "data", "count", "currentPage", "perPage", "totalPages" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "folders", "x-speakeasy-name-override": "find", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.folders.find({});\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Folders.Find(ctx, operations.FolderFindFoldersRequest{})\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.folders.find()\n\n # Handle response\n print(res)" } ] } }, "/folder/create": { "post": { "operationId": "folder-createFolder", "summary": "Create new folder", "description": "Creates a new folder in your team", "tags": [ "Folder" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 100 }, "parentId": { "type": "string" }, "type": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE" ] } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "userId": { "type": "number" }, "teamId": { "type": "number" }, "parentId": { "type": [ "string", "null" ] }, "pinned": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "type": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE" ] } }, "required": [ "id", "name", "userId", "teamId", "parentId", "pinned", "createdAt", "updatedAt", "visibility", "type" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "folders", "x-speakeasy-name-override": "create", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.folders.create({\n name: \"\",\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Folders.Create(ctx, operations.FolderCreateFolderRequest{\n Name: \"\",\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.folders.create(name=\"\")\n\n # Handle response\n print(res)" } ] } }, "/folder/update": { "post": { "operationId": "folder-updateFolder", "summary": "Update folder", "description": "Updates an existing folder", "tags": [ "Folder" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "folderId": { "type": "string" }, "data": { "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 100 }, "parentId": { "type": [ "string", "null" ] }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "pinned": { "type": "boolean" } } } }, "required": [ "folderId", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "userId": { "type": "number" }, "teamId": { "type": "number" }, "parentId": { "type": [ "string", "null" ] }, "pinned": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "type": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE" ] } }, "required": [ "id", "name", "userId", "teamId", "parentId", "pinned", "createdAt", "updatedAt", "visibility", "type" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "folders", "x-speakeasy-name-override": "update", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.folders.update({\n folderId: \"\",\n data: {},\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Folders.Update(ctx, operations.FolderUpdateFolderRequest{\n FolderID: \"\",\n Data: operations.FolderUpdateFolderData{},\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.folders.update(folder_id=\"\", data={})\n\n # Handle response\n print(res)" } ] } }, "/folder/delete": { "post": { "operationId": "folder-deleteFolder", "summary": "Delete folder", "description": "Deletes an existing folder", "tags": [ "Folder" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "folderId": { "type": "string" } }, "required": [ "folderId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "folders", "x-speakeasy-name-override": "delete", "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.folders.delete({\n folderId: \"\",\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Folders.Delete(ctx, operations.FolderDeleteFolderRequest{\n FolderID: \"\",\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.folders.delete(folder_id=\"\")\n\n # Handle response\n print(res)" } ] } }, "/document/recipient/{recipientId}": { "get": { "operationId": "recipient-getDocumentRecipient", "summary": "Get document recipient", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Returns a single recipient. If you want to retrieve all the recipients for a document, use the \"Get Document\" endpoint.", "tags": [ "Document Recipients" ], "security": [ { "apiKey": [] } ], "deprecated": true, "parameters": [ { "in": "path", "name": "recipientId", "schema": { "type": "number" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "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", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] }, "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "signingOrder", "rejectionReason", "fields" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "documents.recipients", "x-speakeasy-name-override": "get", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Documents.Recipients.Get(ctx, 874.3)\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.documents.recipients.get(recipient_id=874.3)\n\n # Handle response\n print(res)" } ] } }, "/document/recipient/create": { "post": { "operationId": "recipient-createDocumentRecipient", "summary": "Create document recipient", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Create a single recipient for a document.", "tags": [ "Document Recipients" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "documentId": { "type": "number" }, "recipient": { "type": "object", "properties": { "email": { "type": "string", "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$", "minLength": 1, "maxLength": 254 }, "name": { "type": "string", "maxLength": 255 }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "signingOrder": { "type": "number" }, "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] }, "default": [] }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] }, "default": [] } }, "required": [ "email", "name", "role" ] } }, "required": [ "documentId", "recipient" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "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", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "signingOrder", "rejectionReason" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "documents.recipients", "x-speakeasy-name-override": "create", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Documents.Recipients.Create(ctx, operations.RecipientCreateDocumentRecipientRequest{\n DocumentID: 3058.31,\n Recipient: operations.RecipientCreateDocumentRecipientRecipient{\n Email: \"Ila.Steuber@yahoo.com\",\n Name: \"\",\n Role: operations.RecipientCreateDocumentRecipientRoleRequestAssistant,\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "import documenso_sdk\nfrom documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.documents.recipients.create(document_id=3058.31, recipient={\n \"email\": \"Ila.Steuber@yahoo.com\",\n \"name\": \"\",\n \"role\": documenso_sdk.RecipientCreateDocumentRecipientRoleRequest.ASSISTANT,\n })\n\n # Handle response\n print(res)" } ] } }, "/document/recipient/create-many": { "post": { "operationId": "recipient-createDocumentRecipients", "summary": "Create document recipients", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Create multiple recipients for a document.", "tags": [ "Document Recipients" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "documentId": { "type": "number" }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$", "minLength": 1, "maxLength": 254 }, "name": { "type": "string", "maxLength": 255 }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "signingOrder": { "type": "number" }, "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] }, "default": [] }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] }, "default": [] } }, "required": [ "email", "name", "role" ] } } }, "required": [ "documentId", "recipients" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "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", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "signingOrder", "rejectionReason" ] } } }, "required": [ "recipients" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "documents.recipients", "x-speakeasy-name-override": "createMany", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Documents.Recipients.CreateMany(ctx, operations.RecipientCreateDocumentRecipientsRequest{\n DocumentID: 9983.95,\n Recipients: []operations.RecipientCreateDocumentRecipientsRecipientRequest{\n operations.RecipientCreateDocumentRecipientsRecipientRequest{\n Email: \"Roosevelt_Baumbach@yahoo.com\",\n Name: \"\",\n Role: operations.RecipientCreateDocumentRecipientsRoleRequestCc,\n },\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "import documenso_sdk\nfrom documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.documents.recipients.create_many(document_id=9983.95, recipients=[\n {\n \"email\": \"Roosevelt_Baumbach@yahoo.com\",\n \"name\": \"\",\n \"role\": documenso_sdk.RecipientCreateDocumentRecipientsRoleRequest.CC,\n },\n ])\n\n # Handle response\n print(res)" } ] } }, "/document/recipient/update": { "post": { "operationId": "recipient-updateDocumentRecipient", "summary": "Update document recipient", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Update a single recipient for a document.", "tags": [ "Document Recipients" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "documentId": { "type": "number" }, "recipient": { "type": "object", "properties": { "id": { "type": "number" }, "email": { "type": "string", "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$", "minLength": 1, "maxLength": 254 }, "name": { "type": "string", "maxLength": 255 }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "signingOrder": { "type": "number" }, "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] }, "default": [] }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] }, "default": [] } }, "required": [ "id" ] } }, "required": [ "documentId", "recipient" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "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", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] }, "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "signingOrder", "rejectionReason", "fields" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "documents.recipients", "x-speakeasy-name-override": "update", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Documents.Recipients.Update(ctx, operations.RecipientUpdateDocumentRecipientRequest{\n DocumentID: 7045.62,\n Recipient: operations.RecipientUpdateDocumentRecipientRecipient{\n ID: 2224.05,\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.documents.recipients.update(document_id=7045.62, recipient={\n \"id\": 2224.05,\n })\n\n # Handle response\n print(res)" } ] } }, "/document/recipient/update-many": { "post": { "operationId": "recipient-updateDocumentRecipients", "summary": "Update document recipients", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Update multiple recipients for a document.", "tags": [ "Document Recipients" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "documentId": { "type": "number" }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "email": { "type": "string", "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$", "minLength": 1, "maxLength": 254 }, "name": { "type": "string", "maxLength": 255 }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "signingOrder": { "type": "number" }, "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] }, "default": [] }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] }, "default": [] } }, "required": [ "id" ] } } }, "required": [ "documentId", "recipients" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "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", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] }, "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "signingOrder", "rejectionReason", "fields" ] } } }, "required": [ "recipients" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "documents.recipients", "x-speakeasy-name-override": "updateMany", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Documents.Recipients.UpdateMany(ctx, operations.RecipientUpdateDocumentRecipientsRequest{\n DocumentID: 3189.76,\n Recipients: []operations.RecipientUpdateDocumentRecipientsRecipientRequest{},\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.documents.recipients.update_many(document_id=3189.76, recipients=[])\n\n # Handle response\n print(res)" } ] } }, "/document/recipient/delete": { "post": { "operationId": "recipient-deleteDocumentRecipient", "summary": "Delete document recipient", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide.", "tags": [ "Document Recipients" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "recipientId": { "type": "number" } }, "required": [ "recipientId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "documents.recipients", "x-speakeasy-name-override": "delete", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Documents.Recipients.Delete(ctx, operations.RecipientDeleteDocumentRecipientRequest{\n RecipientID: 5490.43,\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.documents.recipients.delete(recipient_id=5490.43)\n\n # Handle response\n print(res)" } ] } }, "/template/recipient/{recipientId}": { "get": { "operationId": "recipient-getTemplateRecipient", "summary": "Get template recipient", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Returns a single recipient. If you want to retrieve all the recipients for a template, use the \"Get Template\" endpoint.", "tags": [ "Template Recipients" ], "security": [ { "apiKey": [] } ], "deprecated": true, "parameters": [ { "in": "path", "name": "recipientId", "schema": { "type": "number" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "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", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] }, "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "signingOrder", "rejectionReason", "fields" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "templates.recipients", "x-speakeasy-name-override": "get", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Templates.Recipients.Get(ctx, 9436.42)\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.templates.recipients.get(recipient_id=9436.42)\n\n # Handle response\n print(res)" } ] } }, "/template/recipient/create": { "post": { "operationId": "recipient-createTemplateRecipient", "summary": "Create template recipient", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Create a single recipient for a template.", "tags": [ "Template Recipients" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "number" }, "recipient": { "type": "object", "properties": { "email": { "type": "string", "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$", "minLength": 1, "maxLength": 254 }, "name": { "type": "string", "maxLength": 255 }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "signingOrder": { "type": "number" }, "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] }, "default": [] }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] }, "default": [] } }, "required": [ "email", "name", "role" ] } }, "required": [ "templateId", "recipient" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "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", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "signingOrder", "rejectionReason" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "templates.recipients", "x-speakeasy-name-override": "create", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Templates.Recipients.Create(ctx, operations.RecipientCreateTemplateRecipientRequest{\n TemplateID: 5712.95,\n Recipient: operations.RecipientCreateTemplateRecipientRecipient{\n Email: \"Gerhard88@yahoo.com\",\n Name: \"\",\n Role: operations.RecipientCreateTemplateRecipientRoleRequestSigner,\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "import documenso_sdk\nfrom documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.templates.recipients.create(template_id=5712.95, recipient={\n \"email\": \"Gerhard88@yahoo.com\",\n \"name\": \"\",\n \"role\": documenso_sdk.RecipientCreateTemplateRecipientRoleRequest.SIGNER,\n })\n\n # Handle response\n print(res)" } ] } }, "/template/recipient/create-many": { "post": { "operationId": "recipient-createTemplateRecipients", "summary": "Create template recipients", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Create multiple recipients for a template.", "tags": [ "Template Recipients" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "number" }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$", "minLength": 1, "maxLength": 254 }, "name": { "type": "string", "maxLength": 255 }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "signingOrder": { "type": "number" }, "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] }, "default": [] }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] }, "default": [] } }, "required": [ "email", "name", "role" ] } } }, "required": [ "templateId", "recipients" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "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", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "signingOrder", "rejectionReason" ] } } }, "required": [ "recipients" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "templates.recipients", "x-speakeasy-name-override": "createMany", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Templates.Recipients.CreateMany(ctx, operations.RecipientCreateTemplateRecipientsRequest{\n TemplateID: 5642.48,\n Recipients: []operations.RecipientCreateTemplateRecipientsRecipientRequest{},\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.templates.recipients.create_many(template_id=5642.48, recipients=[])\n\n # Handle response\n print(res)" } ] } }, "/template/recipient/update": { "post": { "operationId": "recipient-updateTemplateRecipient", "summary": "Update template recipient", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Update a single recipient for a template.", "tags": [ "Template Recipients" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "number" }, "recipient": { "type": "object", "properties": { "id": { "type": "number" }, "email": { "type": "string", "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$", "minLength": 1, "maxLength": 254 }, "name": { "type": "string", "maxLength": 255 }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "signingOrder": { "type": "number" }, "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] }, "default": [] }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] }, "default": [] } }, "required": [ "id" ] } }, "required": [ "templateId", "recipient" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "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", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] }, "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "signingOrder", "rejectionReason", "fields" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "templates.recipients", "x-speakeasy-name-override": "update", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Templates.Recipients.Update(ctx, operations.RecipientUpdateTemplateRecipientRequest{\n TemplateID: 2984.61,\n Recipient: operations.RecipientUpdateTemplateRecipientRecipient{\n ID: 8617.99,\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.templates.recipients.update(template_id=2984.61, recipient={\n \"id\": 8617.99,\n })\n\n # Handle response\n print(res)" } ] } }, "/template/recipient/update-many": { "post": { "operationId": "recipient-updateTemplateRecipients", "summary": "Update template recipients", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Update multiple recipients for a template.", "tags": [ "Template Recipients" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "number" }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "email": { "type": "string", "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$", "minLength": 1, "maxLength": 254 }, "name": { "type": "string", "maxLength": 255 }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "signingOrder": { "type": "number" }, "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] }, "default": [] }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] }, "default": [] } }, "required": [ "id" ] } } }, "required": [ "templateId", "recipients" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "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", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] }, "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "signingOrder", "rejectionReason", "fields" ] } } }, "required": [ "recipients" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "templates.recipients", "x-speakeasy-name-override": "updateMany", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Templates.Recipients.UpdateMany(ctx, operations.RecipientUpdateTemplateRecipientsRequest{\n TemplateID: 5597.58,\n Recipients: []operations.RecipientUpdateTemplateRecipientsRecipientRequest{\n operations.RecipientUpdateTemplateRecipientsRecipientRequest{\n ID: 1630.42,\n },\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.templates.recipients.update_many(template_id=5597.58, recipients=[\n {\n \"id\": 1630.42,\n },\n ])\n\n # Handle response\n print(res)" } ] } }, "/template/recipient/delete": { "post": { "operationId": "recipient-deleteTemplateRecipient", "summary": "Delete template recipient", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide.", "tags": [ "Template Recipients" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "recipientId": { "type": "number" } }, "required": [ "recipientId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "templates.recipients", "x-speakeasy-name-override": "delete", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Templates.Recipients.Delete(ctx, operations.RecipientDeleteTemplateRecipientRequest{\n RecipientID: 312.69,\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.templates.recipients.delete(recipient_id=312.69)\n\n # Handle response\n print(res)" } ] } }, "/template": { "get": { "operationId": "template-findTemplates", "summary": "Find templates", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Find templates based on a search criteria", "tags": [ "Template" ], "security": [ { "apiKey": [] } ], "deprecated": true, "parameters": [ { "in": "query", "name": "query", "description": "The search query.", "schema": { "type": "string" } }, { "in": "query", "name": "page", "description": "The pagination page number, starts at 1.", "schema": { "type": "number", "minimum": 1 } }, { "in": "query", "name": "perPage", "description": "The number of items per page.", "schema": { "type": "number", "minimum": 1, "maximum": 100 } }, { "in": "query", "name": "type", "description": "Filter templates by type.", "schema": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "ORGANISATION" ] } }, { "in": "query", "name": "folderId", "description": "The ID of the folder to filter templates by.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "ORGANISATION" ] }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "id": { "type": "number" }, "externalId": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "userId": { "type": "number" }, "teamId": { "type": "number" }, "authOptions": { "type": [ "object", "null" ], "properties": { "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } } }, "required": [ "globalAccessAuth", "globalActionAuth" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "publicTitle": { "type": "string" }, "publicDescription": { "type": "string" }, "folderId": { "type": [ "string", "null" ] }, "useLegacyFieldInsertion": { "type": "boolean" }, "envelopeId": { "type": "string" }, "team": { "type": [ "object", "null" ], "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] }, "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } }, "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", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "signingOrder", "rejectionReason" ] } }, "templateMeta": { "type": [ "object", "null" ], "properties": { "signingOrder": { "type": "string", "enum": [ "PARALLEL", "SEQUENTIAL" ] }, "distributionMethod": { "type": "string", "enum": [ "EMAIL", "NONE" ] } }, "required": [ "signingOrder", "distributionMethod" ] }, "directLink": { "type": [ "object", "null" ], "properties": { "token": { "type": "string" }, "enabled": { "type": "boolean" } }, "required": [ "token", "enabled" ] }, "templateDocumentDataId": { "type": "string", "default": "" } }, "required": [ "type", "visibility", "id", "externalId", "title", "userId", "teamId", "authOptions", "createdAt", "updatedAt", "publicTitle", "publicDescription", "folderId", "useLegacyFieldInsertion", "envelopeId", "team", "fields", "recipients", "templateMeta", "directLink", "templateDocumentDataId" ] } }, "count": { "type": "number" }, "currentPage": { "type": "number" }, "perPage": { "type": "number" }, "totalPages": { "type": "number" } }, "required": [ "data", "count", "currentPage", "perPage", "totalPages" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "templates", "x-speakeasy-name-override": "find", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Templates.Find(ctx, operations.TemplateFindTemplatesRequest{})\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.templates.find()\n\n # Handle response\n print(res)" } ] } }, "/template/{templateId}": { "get": { "operationId": "template-getTemplateById", "summary": "Get template", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide.", "tags": [ "Template" ], "security": [ { "apiKey": [] } ], "deprecated": true, "parameters": [ { "in": "path", "name": "templateId", "schema": { "type": "number" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "ORGANISATION" ] }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "id": { "type": "number" }, "externalId": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "userId": { "type": "number" }, "teamId": { "type": "number" }, "authOptions": { "type": [ "object", "null" ], "properties": { "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } } }, "required": [ "globalAccessAuth", "globalActionAuth" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "publicTitle": { "type": "string" }, "publicDescription": { "type": "string" }, "folderId": { "type": [ "string", "null" ] }, "envelopeId": { "type": "string" }, "templateDocumentDataId": { "type": "string", "default": "" }, "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", "null" ] }, "message": { "type": [ "string", "null" ] }, "timezone": { "type": [ "string", "null" ] }, "dateFormat": { "type": [ "string", "null" ], "x-speakeasy-enums": [ "YyyyMMddHhMmA", "YyyyMMdd", "DdMMSlashYyyy", "DdMMDashYyyy", "MmDdSlashYyyy", "YyMMdd", "MmmmDdCommaYyyy", "EeeeMmmmDdCommaYyyy", "DdMMSlashYyyyHhMmA", "DdMMSlashYyyyHHmm", "DdMMDashYyyyHhMmA", "DdMMDashYyyyHHmm", "MmDdSlashYyyyHhMmA", "MmDdSlashYyyyHHmm", "DdDotMmDotYyyy", "DdDotMmDotYyyyHHmm", "YyyyMMddHHmm", "YyMMddHhMmA", "YyMMddHHmm", "YyyyMMddHHmmss", "MmmmDdCommaYyyyHhMmA", "MmmmDdCommaYyyyHHmm", "EeeeMmmmDdCommaYyyyHhMmA", "EeeeMmmmDdCommaYyyyHHmm", "Iso8601Full" ] }, "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", "null" ] }, "language": { "type": "string" }, "emailSettings": { "type": [ "object", "null" ], "properties": { "recipientSigningRequest": { "type": "boolean", "default": true }, "recipientRemoved": { "type": "boolean", "default": true }, "recipientSigned": { "type": "boolean", "default": true }, "documentPending": { "type": "boolean", "default": true }, "documentCompleted": { "type": "boolean", "default": true }, "documentDeleted": { "type": "boolean", "default": true }, "ownerDocumentCompleted": { "type": "boolean", "default": true }, "ownerRecipientExpired": { "type": "boolean", "default": true }, "ownerDocumentCreated": { "type": "boolean", "default": true } }, "required": [ "recipientSigningRequest", "recipientRemoved", "recipientSigned", "documentPending", "documentCompleted", "documentDeleted", "ownerDocumentCompleted", "ownerRecipientExpired", "ownerDocumentCreated" ], "default": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true } }, "emailId": { "type": [ "string", "null" ] }, "emailReplyTo": { "type": [ "string", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "id", "subject", "message", "timezone", "dateFormat", "signingOrder", "typedSignatureEnabled", "uploadSignatureEnabled", "drawSignatureEnabled", "allowDictateNextSigner", "distributionMethod", "redirectUrl", "language", "emailSettings", "emailId", "emailReplyTo", "templateId" ] }, "directLink": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "envelopeId": { "type": "string" }, "token": { "type": "string" }, "createdAt": { "type": "string" }, "enabled": { "type": "boolean" }, "directTemplateRecipientId": { "type": "number" }, "templateId": { "type": "number" } }, "required": [ "id", "envelopeId", "token", "createdAt", "enabled", "directTemplateRecipientId", "templateId" ] }, "user": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": [ "string", "null" ] }, "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", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } }, "folder": { "type": [ "object", "null" ], "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", "null" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "type", "visibility", "userId", "teamId", "pinned", "parentId", "createdAt", "updatedAt" ] }, "envelopeItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "envelopeId": { "type": "string" } }, "required": [ "id", "envelopeId" ] } } }, "required": [ "type", "visibility", "id", "externalId", "title", "userId", "teamId", "authOptions", "createdAt", "updatedAt", "publicTitle", "publicDescription", "folderId", "envelopeId", "templateDocumentDataId", "templateDocumentData", "templateMeta", "directLink", "user", "recipients", "fields", "folder", "envelopeItems" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "templates", "x-speakeasy-name-override": "get", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Templates.Get(ctx, 2128.54)\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.templates.get(template_id=2128.54)\n\n # Handle response\n print(res)" } ] } }, "/template/get-many": { "post": { "operationId": "template-getMany", "summary": "Get multiple templates", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Retrieve multiple templates by their IDs", "tags": [ "Template" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "templateIds": { "type": "array", "items": { "type": "number" }, "minItems": 1 } }, "required": [ "templateIds" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "ORGANISATION" ] }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "id": { "type": "number" }, "externalId": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "userId": { "type": "number" }, "teamId": { "type": "number" }, "authOptions": { "type": [ "object", "null" ], "properties": { "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } } }, "required": [ "globalAccessAuth", "globalActionAuth" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "publicTitle": { "type": "string" }, "publicDescription": { "type": "string" }, "folderId": { "type": [ "string", "null" ] }, "useLegacyFieldInsertion": { "type": "boolean" }, "envelopeId": { "type": "string" }, "team": { "type": [ "object", "null" ], "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] }, "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } }, "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", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "signingOrder", "rejectionReason" ] } }, "templateMeta": { "type": [ "object", "null" ], "properties": { "signingOrder": { "type": "string", "enum": [ "PARALLEL", "SEQUENTIAL" ] }, "distributionMethod": { "type": "string", "enum": [ "EMAIL", "NONE" ] } }, "required": [ "signingOrder", "distributionMethod" ] }, "directLink": { "type": [ "object", "null" ], "properties": { "token": { "type": "string" }, "enabled": { "type": "boolean" } }, "required": [ "token", "enabled" ] }, "templateDocumentDataId": { "type": "string", "default": "" } }, "required": [ "type", "visibility", "id", "externalId", "title", "userId", "teamId", "authOptions", "createdAt", "updatedAt", "publicTitle", "publicDescription", "folderId", "useLegacyFieldInsertion", "envelopeId", "team", "fields", "recipients", "templateMeta", "directLink", "templateDocumentDataId" ] } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Template.TemplateGetMany(ctx, operations.TemplateGetManyRequest{\n TemplateIds: []float64{\n 618.65,\n 1418.73,\n 1001.18,\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.template.template_get_many(template_ids=[\n 618.65,\n 1418.73,\n 1001.18,\n ])\n\n # Handle response\n print(res)" } ] } }, "/template/create": { "post": { "operationId": "template-createTemplate", "summary": "Create template", "description": "Create a new template. Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide.", "tags": [ "Template" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "folderId": { "type": "string" }, "externalId": { "type": [ "string", "null" ] }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] }, "default": [] }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] }, "default": [] }, "publicTitle": { "type": "string", "minLength": 1, "maxLength": 50 }, "publicDescription": { "type": "string", "minLength": 1, "maxLength": 256 }, "type": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "ORGANISATION" ] }, "meta": { "type": "object", "properties": { "subject": { "type": "string", "maxLength": 254 }, "message": { "type": "string", "maxLength": 5000 }, "timezone": { "type": "string" }, "dateFormat": { "type": "string", "enum": [ "yyyy-MM-dd hh:mm a", "yyyy-MM-dd", "dd/MM/yyyy", "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", "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" ], "x-speakeasy-enums": [ "YyyyMMddHhMmA", "YyyyMMdd", "DdMMSlashYyyy", "DdMMDashYyyy", "MmDdSlashYyyy", "YyMMdd", "MmmmDdCommaYyyy", "EeeeMmmmDdCommaYyyy", "DdMMSlashYyyyHhMmA", "DdMMSlashYyyyHHmm", "DdMMDashYyyyHhMmA", "DdMMDashYyyyHHmm", "MmDdSlashYyyyHhMmA", "MmDdSlashYyyyHHmm", "DdDotMmDotYyyy", "DdDotMmDotYyyyHHmm", "YyyyMMddHHmm", "YyMMddHhMmA", "YyMMddHHmm", "YyyyMMddHHmmss", "MmmmDdCommaYyyyHhMmA", "MmmmDdCommaYyyyHHmm", "EeeeMmmmDdCommaYyyyHhMmA", "EeeeMmmmDdCommaYyyyHHmm", "Iso8601Full" ] }, "distributionMethod": { "type": "string", "enum": [ "EMAIL", "NONE" ] }, "emailId": { "type": [ "string", "null" ] }, "emailReplyTo": { "type": [ "string", "null" ], "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$" }, "emailSettings": { "type": "object", "properties": { "recipientSigningRequest": { "type": "boolean", "default": true }, "recipientRemoved": { "type": "boolean", "default": true }, "recipientSigned": { "type": "boolean", "default": true }, "documentPending": { "type": "boolean", "default": true }, "documentCompleted": { "type": "boolean", "default": true }, "documentDeleted": { "type": "boolean", "default": true }, "ownerDocumentCompleted": { "type": "boolean", "default": true }, "ownerRecipientExpired": { "type": "boolean", "default": true }, "ownerDocumentCreated": { "type": "boolean", "default": true } }, "default": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true } }, "redirectUrl": { "type": "string" }, "language": { "type": "string", "enum": [ "de", "en", "fr", "es", "it", "nl", "pl", "pt-BR", "ja", "ko", "zh" ] }, "typedSignatureEnabled": { "type": "boolean" }, "uploadSignatureEnabled": { "type": "boolean" }, "drawSignatureEnabled": { "type": "boolean" }, "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": { "type": "string", "enum": [ "link" ], "default": "link" } }, "required": [ "label", "data" ] } } }, "required": [ "title" ] }, "file": { "type": "string", "contentMediaType": "application/octet-stream" } }, "required": [ "payload", "file" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "id": { "type": "number" } }, "required": [ "envelopeId", "id" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "templates", "x-speakeasy-name-override": "create", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n example, fileErr := os.Open(\"example.file\")\n if fileErr != nil {\n panic(fileErr)\n }\n\n res, err := s.Templates.Create(ctx, operations.TemplateCreateTemplateRequest{\n Payload: operations.TemplateCreateTemplatePayload{\n Title: \"\",\n },\n File: operations.TemplateCreateTemplateFile{\n FileName: \"example.file\",\n Content: example,\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.templates.create(payload={\n \"title\": \"\",\n }, file={\n \"file_name\": \"example.file\",\n \"content\": open(\"example.file\", \"rb\"),\n })\n\n # Handle response\n print(res)" } ] } }, "/template/create/beta": { "post": { "operationId": "template-createTemplateTemporary", "summary": "Create template", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. You will need to upload the PDF to the provided URL returned. Note: Once V2 API is released, this will be removed since we will allow direct uploads, instead of using an upload URL.", "tags": [ "Template" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "folderId": { "type": "string" }, "externalId": { "type": [ "string", "null" ] }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] }, "default": [] }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] }, "default": [] }, "publicTitle": { "type": "string", "minLength": 1, "maxLength": 50 }, "publicDescription": { "type": "string", "minLength": 1, "maxLength": 256 }, "type": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "ORGANISATION" ] }, "meta": { "type": "object", "properties": { "subject": { "type": "string", "maxLength": 254 }, "message": { "type": "string", "maxLength": 5000 }, "timezone": { "type": "string" }, "dateFormat": { "type": "string", "enum": [ "yyyy-MM-dd hh:mm a", "yyyy-MM-dd", "dd/MM/yyyy", "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", "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" ], "x-speakeasy-enums": [ "YyyyMMddHhMmA", "YyyyMMdd", "DdMMSlashYyyy", "DdMMDashYyyy", "MmDdSlashYyyy", "YyMMdd", "MmmmDdCommaYyyy", "EeeeMmmmDdCommaYyyy", "DdMMSlashYyyyHhMmA", "DdMMSlashYyyyHHmm", "DdMMDashYyyyHhMmA", "DdMMDashYyyyHHmm", "MmDdSlashYyyyHhMmA", "MmDdSlashYyyyHHmm", "DdDotMmDotYyyy", "DdDotMmDotYyyyHHmm", "YyyyMMddHHmm", "YyMMddHhMmA", "YyMMddHHmm", "YyyyMMddHHmmss", "MmmmDdCommaYyyyHhMmA", "MmmmDdCommaYyyyHHmm", "EeeeMmmmDdCommaYyyyHhMmA", "EeeeMmmmDdCommaYyyyHHmm", "Iso8601Full" ] }, "distributionMethod": { "type": "string", "enum": [ "EMAIL", "NONE" ] }, "emailId": { "type": [ "string", "null" ] }, "emailReplyTo": { "type": [ "string", "null" ], "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$" }, "emailSettings": { "type": "object", "properties": { "recipientSigningRequest": { "type": "boolean", "default": true }, "recipientRemoved": { "type": "boolean", "default": true }, "recipientSigned": { "type": "boolean", "default": true }, "documentPending": { "type": "boolean", "default": true }, "documentCompleted": { "type": "boolean", "default": true }, "documentDeleted": { "type": "boolean", "default": true }, "ownerDocumentCompleted": { "type": "boolean", "default": true }, "ownerRecipientExpired": { "type": "boolean", "default": true }, "ownerDocumentCreated": { "type": "boolean", "default": true } }, "default": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true } }, "redirectUrl": { "type": "string" }, "language": { "type": "string", "enum": [ "de", "en", "fr", "es", "it", "nl", "pl", "pt-BR", "ja", "ko", "zh" ] }, "typedSignatureEnabled": { "type": "boolean" }, "uploadSignatureEnabled": { "type": "boolean" }, "drawSignatureEnabled": { "type": "boolean" }, "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": { "type": "string", "enum": [ "link" ], "default": "link" } }, "required": [ "label", "data" ] } } }, "required": [ "title" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "template": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "ORGANISATION" ] }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "id": { "type": "number" }, "externalId": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "userId": { "type": "number" }, "teamId": { "type": "number" }, "authOptions": { "type": [ "object", "null" ], "properties": { "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } } }, "required": [ "globalAccessAuth", "globalActionAuth" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "publicTitle": { "type": "string" }, "publicDescription": { "type": "string" }, "folderId": { "type": [ "string", "null" ] }, "envelopeId": { "type": "string" }, "templateDocumentDataId": { "type": "string", "default": "" }, "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", "null" ] }, "message": { "type": [ "string", "null" ] }, "timezone": { "type": [ "string", "null" ] }, "dateFormat": { "type": [ "string", "null" ], "x-speakeasy-enums": [ "YyyyMMddHhMmA", "YyyyMMdd", "DdMMSlashYyyy", "DdMMDashYyyy", "MmDdSlashYyyy", "YyMMdd", "MmmmDdCommaYyyy", "EeeeMmmmDdCommaYyyy", "DdMMSlashYyyyHhMmA", "DdMMSlashYyyyHHmm", "DdMMDashYyyyHhMmA", "DdMMDashYyyyHHmm", "MmDdSlashYyyyHhMmA", "MmDdSlashYyyyHHmm", "DdDotMmDotYyyy", "DdDotMmDotYyyyHHmm", "YyyyMMddHHmm", "YyMMddHhMmA", "YyMMddHHmm", "YyyyMMddHHmmss", "MmmmDdCommaYyyyHhMmA", "MmmmDdCommaYyyyHHmm", "EeeeMmmmDdCommaYyyyHhMmA", "EeeeMmmmDdCommaYyyyHHmm", "Iso8601Full" ] }, "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", "null" ] }, "language": { "type": "string" }, "emailSettings": { "type": [ "object", "null" ], "properties": { "recipientSigningRequest": { "type": "boolean", "default": true }, "recipientRemoved": { "type": "boolean", "default": true }, "recipientSigned": { "type": "boolean", "default": true }, "documentPending": { "type": "boolean", "default": true }, "documentCompleted": { "type": "boolean", "default": true }, "documentDeleted": { "type": "boolean", "default": true }, "ownerDocumentCompleted": { "type": "boolean", "default": true }, "ownerRecipientExpired": { "type": "boolean", "default": true }, "ownerDocumentCreated": { "type": "boolean", "default": true } }, "required": [ "recipientSigningRequest", "recipientRemoved", "recipientSigned", "documentPending", "documentCompleted", "documentDeleted", "ownerDocumentCompleted", "ownerRecipientExpired", "ownerDocumentCreated" ], "default": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true } }, "emailId": { "type": [ "string", "null" ] }, "emailReplyTo": { "type": [ "string", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "id", "subject", "message", "timezone", "dateFormat", "signingOrder", "typedSignatureEnabled", "uploadSignatureEnabled", "drawSignatureEnabled", "allowDictateNextSigner", "distributionMethod", "redirectUrl", "language", "emailSettings", "emailId", "emailReplyTo", "templateId" ] }, "directLink": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "envelopeId": { "type": "string" }, "token": { "type": "string" }, "createdAt": { "type": "string" }, "enabled": { "type": "boolean" }, "directTemplateRecipientId": { "type": "number" }, "templateId": { "type": "number" } }, "required": [ "id", "envelopeId", "token", "createdAt", "enabled", "directTemplateRecipientId", "templateId" ] }, "user": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": [ "string", "null" ] }, "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", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } }, "folder": { "type": [ "object", "null" ], "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", "null" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "type", "visibility", "userId", "teamId", "pinned", "parentId", "createdAt", "updatedAt" ] }, "envelopeItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "envelopeId": { "type": "string" } }, "required": [ "id", "envelopeId" ] } } }, "required": [ "type", "visibility", "id", "externalId", "title", "userId", "teamId", "authOptions", "createdAt", "updatedAt", "publicTitle", "publicDescription", "folderId", "envelopeId", "templateDocumentDataId", "templateDocumentData", "templateMeta", "directLink", "user", "recipients", "fields", "folder", "envelopeItems" ] }, "uploadUrl": { "type": "string", "minLength": 1 } }, "required": [ "template", "uploadUrl" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Template.TemplateCreateTemplateTemporary(ctx, operations.TemplateCreateTemplateTemporaryRequest{\n Title: \"\",\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.template.template_create_template_temporary(title=\"\")\n\n # Handle response\n print(res)" } ] } }, "/template/update": { "post": { "operationId": "template-updateTemplate", "summary": "Update template", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide.", "tags": [ "Template" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "number" }, "data": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "externalId": { "type": [ "string", "null" ] }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] }, "default": [] }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] }, "default": [] }, "publicTitle": { "type": "string", "minLength": 1, "maxLength": 50 }, "publicDescription": { "type": "string", "minLength": 1, "maxLength": 256 }, "type": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "ORGANISATION" ] }, "useLegacyFieldInsertion": { "type": "boolean" }, "folderId": { "type": [ "string", "null" ] } } }, "meta": { "type": "object", "properties": { "subject": { "type": "string", "maxLength": 254 }, "message": { "type": "string", "maxLength": 5000 }, "timezone": { "type": "string" }, "dateFormat": { "type": "string", "enum": [ "yyyy-MM-dd hh:mm a", "yyyy-MM-dd", "dd/MM/yyyy", "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", "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" ], "x-speakeasy-enums": [ "YyyyMMddHhMmA", "YyyyMMdd", "DdMMSlashYyyy", "DdMMDashYyyy", "MmDdSlashYyyy", "YyMMdd", "MmmmDdCommaYyyy", "EeeeMmmmDdCommaYyyy", "DdMMSlashYyyyHhMmA", "DdMMSlashYyyyHHmm", "DdMMDashYyyyHhMmA", "DdMMDashYyyyHHmm", "MmDdSlashYyyyHhMmA", "MmDdSlashYyyyHHmm", "DdDotMmDotYyyy", "DdDotMmDotYyyyHHmm", "YyyyMMddHHmm", "YyMMddHhMmA", "YyMMddHHmm", "YyyyMMddHHmmss", "MmmmDdCommaYyyyHhMmA", "MmmmDdCommaYyyyHHmm", "EeeeMmmmDdCommaYyyyHhMmA", "EeeeMmmmDdCommaYyyyHHmm", "Iso8601Full" ] }, "distributionMethod": { "type": "string", "enum": [ "EMAIL", "NONE" ] }, "emailId": { "type": [ "string", "null" ] }, "emailReplyTo": { "type": [ "string", "null" ], "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$" }, "emailSettings": { "type": "object", "properties": { "recipientSigningRequest": { "type": "boolean", "default": true }, "recipientRemoved": { "type": "boolean", "default": true }, "recipientSigned": { "type": "boolean", "default": true }, "documentPending": { "type": "boolean", "default": true }, "documentCompleted": { "type": "boolean", "default": true }, "documentDeleted": { "type": "boolean", "default": true }, "ownerDocumentCompleted": { "type": "boolean", "default": true }, "ownerRecipientExpired": { "type": "boolean", "default": true }, "ownerDocumentCreated": { "type": "boolean", "default": true } }, "default": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true } }, "redirectUrl": { "type": "string" }, "language": { "type": "string", "enum": [ "de", "en", "fr", "es", "it", "nl", "pl", "pt-BR", "ja", "ko", "zh" ] }, "typedSignatureEnabled": { "type": "boolean" }, "uploadSignatureEnabled": { "type": "boolean" }, "drawSignatureEnabled": { "type": "boolean" }, "signingOrder": { "type": "string", "enum": [ "PARALLEL", "SEQUENTIAL" ] }, "allowDictateNextSigner": { "type": "boolean" } } } }, "required": [ "templateId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "ORGANISATION" ] }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "id": { "type": "number" }, "externalId": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "userId": { "type": "number" }, "teamId": { "type": "number" }, "authOptions": { "type": [ "object", "null" ], "properties": { "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } } }, "required": [ "globalAccessAuth", "globalActionAuth" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "publicTitle": { "type": "string" }, "publicDescription": { "type": "string" }, "folderId": { "type": [ "string", "null" ] }, "useLegacyFieldInsertion": { "type": "boolean" }, "envelopeId": { "type": "string" }, "templateDocumentDataId": { "type": "string", "default": "" } }, "required": [ "type", "visibility", "id", "externalId", "title", "userId", "teamId", "authOptions", "createdAt", "updatedAt", "publicTitle", "publicDescription", "folderId", "useLegacyFieldInsertion", "envelopeId", "templateDocumentDataId" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "templates", "x-speakeasy-name-override": "update", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Templates.Update(ctx, operations.TemplateUpdateTemplateRequest{\n TemplateID: 9404.77,\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.templates.update(template_id=9404.77)\n\n # Handle response\n print(res)" } ] } }, "/template/duplicate": { "post": { "operationId": "template-duplicateTemplate", "summary": "Duplicate template", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide.", "tags": [ "Template" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "number" } }, "required": [ "templateId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "ORGANISATION" ] }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "id": { "type": "number" }, "externalId": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "userId": { "type": "number" }, "teamId": { "type": "number" }, "authOptions": { "type": [ "object", "null" ], "properties": { "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } } }, "required": [ "globalAccessAuth", "globalActionAuth" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "publicTitle": { "type": "string" }, "publicDescription": { "type": "string" }, "folderId": { "type": [ "string", "null" ] }, "useLegacyFieldInsertion": { "type": "boolean" }, "envelopeId": { "type": "string" }, "templateDocumentDataId": { "type": "string", "default": "" } }, "required": [ "type", "visibility", "id", "externalId", "title", "userId", "teamId", "authOptions", "createdAt", "updatedAt", "publicTitle", "publicDescription", "folderId", "useLegacyFieldInsertion", "envelopeId", "templateDocumentDataId" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "templates", "x-speakeasy-name-override": "duplicate", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Templates.Duplicate(ctx, operations.TemplateDuplicateTemplateRequest{\n TemplateID: 2490.16,\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.templates.duplicate(template_id=2490.16)\n\n # Handle response\n print(res)" } ] } }, "/template/delete": { "post": { "operationId": "template-deleteTemplate", "summary": "Delete template", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide.", "tags": [ "Template" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "number" } }, "required": [ "templateId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "templates", "x-speakeasy-name-override": "delete", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Templates.Delete(ctx, operations.TemplateDeleteTemplateRequest{\n TemplateID: 536.89,\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.templates.delete(template_id=536.89)\n\n # Handle response\n print(res)" } ] } }, "/template/use": { "post": { "operationId": "template-createDocumentFromTemplate", "summary": "Use template", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Use the template to create a document", "tags": [ "Template" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "number" }, "externalId": { "type": "string", "maxLength": 255 }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "email": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": "string", "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$", "maxLength": 254 } ] }, "name": { "type": "string", "maxLength": 255 } }, "required": [ "id", "email" ] } }, "distributeDocument": { "type": "boolean" }, "customDocumentDataId": { "type": "string" }, "customDocumentData": { "type": "array", "items": { "type": "object", "properties": { "documentDataId": { "type": "string" }, "envelopeItemId": { "type": "string" } }, "required": [ "documentDataId", "envelopeItemId" ] } }, "folderId": { "type": "string" }, "prefillFields": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "id": { "type": "number" } }, "required": [ "id" ] }, { "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" ] } ] } ] } }, "override": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "subject": { "type": "string", "maxLength": 254 }, "message": { "type": "string", "maxLength": 5000 }, "timezone": { "type": "string" }, "dateFormat": { "type": "string", "enum": [ "yyyy-MM-dd hh:mm a", "yyyy-MM-dd", "dd/MM/yyyy", "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", "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" ], "x-speakeasy-enums": [ "YyyyMMddHhMmA", "YyyyMMdd", "DdMMSlashYyyy", "DdMMDashYyyy", "MmDdSlashYyyy", "YyMMdd", "MmmmDdCommaYyyy", "EeeeMmmmDdCommaYyyy", "DdMMSlashYyyyHhMmA", "DdMMSlashYyyyHHmm", "DdMMDashYyyyHhMmA", "DdMMDashYyyyHHmm", "MmDdSlashYyyyHhMmA", "MmDdSlashYyyyHHmm", "DdDotMmDotYyyy", "DdDotMmDotYyyyHHmm", "YyyyMMddHHmm", "YyMMddHhMmA", "YyMMddHHmm", "YyyyMMddHHmmss", "MmmmDdCommaYyyyHhMmA", "MmmmDdCommaYyyyHHmm", "EeeeMmmmDdCommaYyyyHhMmA", "EeeeMmmmDdCommaYyyyHHmm", "Iso8601Full" ] }, "redirectUrl": { "type": "string" }, "distributionMethod": { "type": "string", "enum": [ "EMAIL", "NONE" ] }, "emailSettings": { "type": "object", "properties": { "recipientSigningRequest": { "type": "boolean", "default": true }, "recipientRemoved": { "type": "boolean", "default": true }, "recipientSigned": { "type": "boolean", "default": true }, "documentPending": { "type": "boolean", "default": true }, "documentCompleted": { "type": "boolean", "default": true }, "documentDeleted": { "type": "boolean", "default": true }, "ownerDocumentCompleted": { "type": "boolean", "default": true }, "ownerRecipientExpired": { "type": "boolean", "default": true }, "ownerDocumentCreated": { "type": "boolean", "default": true } }, "default": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true } }, "language": { "type": "string", "enum": [ "de", "en", "fr", "es", "it", "nl", "pl", "pt-BR", "ja", "ko", "zh" ] }, "typedSignatureEnabled": { "type": "boolean" }, "uploadSignatureEnabled": { "type": "boolean" }, "drawSignatureEnabled": { "type": "boolean" }, "allowDictateNextSigner": { "type": "boolean" }, "envelopeExpirationPeriod": { "nullable": true, "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month", "year" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] } } }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "data": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": [ "link" ], "default": "link" } }, "required": [ "label", "data" ] } }, "formValues": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } } }, "required": [ "templateId", "recipients" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "COMPLETED", "REJECTED", "CANCELLED" ] }, "source": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE", "TEMPLATE_DIRECT_LINK" ] }, "id": { "type": "number" }, "externalId": { "type": [ "string", "null" ] }, "userId": { "type": "number" }, "authOptions": { "type": [ "object", "null" ], "properties": { "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } } }, "required": [ "globalAccessAuth", "globalActionAuth" ] }, "formValues": { "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "title": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "completedAt": { "type": [ "string", "null" ] }, "deletedAt": { "type": [ "string", "null" ] }, "teamId": { "type": "number" }, "folderId": { "type": [ "string", "null" ] }, "envelopeId": { "type": "string" }, "internalVersion": { "type": "number" }, "templateId": { "type": [ "number", "null" ] }, "documentDataId": { "type": "string", "default": "" }, "documentData": { "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" ] }, "documentMeta": { "type": "object", "properties": { "signingOrder": { "type": "string", "enum": [ "PARALLEL", "SEQUENTIAL" ] }, "distributionMethod": { "type": "string", "enum": [ "EMAIL", "NONE" ] }, "id": { "type": "string" }, "subject": { "type": [ "string", "null" ] }, "message": { "type": [ "string", "null" ] }, "timezone": { "type": [ "string", "null" ] }, "dateFormat": { "type": [ "string", "null" ], "x-speakeasy-enums": [ "YyyyMMddHhMmA", "YyyyMMdd", "DdMMSlashYyyy", "DdMMDashYyyy", "MmDdSlashYyyy", "YyMMdd", "MmmmDdCommaYyyy", "EeeeMmmmDdCommaYyyy", "DdMMSlashYyyyHhMmA", "DdMMSlashYyyyHHmm", "DdMMDashYyyyHhMmA", "DdMMDashYyyyHHmm", "MmDdSlashYyyyHhMmA", "MmDdSlashYyyyHHmm", "DdDotMmDotYyyy", "DdDotMmDotYyyyHHmm", "YyyyMMddHHmm", "YyMMddHhMmA", "YyMMddHHmm", "YyyyMMddHHmmss", "MmmmDdCommaYyyyHhMmA", "MmmmDdCommaYyyyHHmm", "EeeeMmmmDdCommaYyyyHhMmA", "EeeeMmmmDdCommaYyyyHHmm", "Iso8601Full" ] }, "redirectUrl": { "type": [ "string", "null" ] }, "typedSignatureEnabled": { "type": "boolean" }, "uploadSignatureEnabled": { "type": "boolean" }, "drawSignatureEnabled": { "type": "boolean" }, "allowDictateNextSigner": { "type": "boolean" }, "language": { "type": "string" }, "emailSettings": { "type": [ "object", "null" ], "properties": { "recipientSigningRequest": { "type": "boolean", "default": true }, "recipientRemoved": { "type": "boolean", "default": true }, "recipientSigned": { "type": "boolean", "default": true }, "documentPending": { "type": "boolean", "default": true }, "documentCompleted": { "type": "boolean", "default": true }, "documentDeleted": { "type": "boolean", "default": true }, "ownerDocumentCompleted": { "type": "boolean", "default": true }, "ownerRecipientExpired": { "type": "boolean", "default": true }, "ownerDocumentCreated": { "type": "boolean", "default": true } }, "required": [ "recipientSigningRequest", "recipientRemoved", "recipientSigned", "documentPending", "documentCompleted", "documentDeleted", "ownerDocumentCompleted", "ownerRecipientExpired", "ownerDocumentCreated" ], "default": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true } }, "emailId": { "type": [ "string", "null" ] }, "emailReplyTo": { "type": [ "string", "null" ] }, "envelopeExpirationPeriod": { "nullable": true, "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month", "year" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] }, "reminderSettings": { "type": [ "object", "null" ], "properties": { "sendAfter": { "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] }, "repeatEvery": { "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ] }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ] } ] } }, "required": [ "sendAfter", "repeatEvery" ] }, "password": { "type": [ "string", "null" ], "default": null }, "documentId": { "type": "number", "default": -1 } }, "required": [ "signingOrder", "distributionMethod", "id", "subject", "message", "timezone", "dateFormat", "redirectUrl", "typedSignatureEnabled", "uploadSignatureEnabled", "drawSignatureEnabled", "allowDictateNextSigner", "language", "emailSettings", "emailId", "emailReplyTo", "envelopeExpirationPeriod", "reminderSettings", "password" ] }, "envelopeItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "envelopeId": { "type": "string" } }, "required": [ "id", "envelopeId" ] } }, "folder": { "type": [ "object", "null" ], "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", "null" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "type", "visibility", "userId", "teamId", "pinned", "parentId", "createdAt", "updatedAt" ] }, "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", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "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" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "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": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ] }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ] } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } } }, "required": [ "visibility", "status", "source", "id", "externalId", "userId", "authOptions", "formValues", "title", "createdAt", "updatedAt", "completedAt", "deletedAt", "teamId", "folderId", "envelopeId", "internalVersion", "documentDataId", "documentData", "documentMeta", "envelopeItems", "folder", "recipients", "fields" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "templates", "x-speakeasy-name-override": "use", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Templates.Use(ctx, operations.TemplateCreateDocumentFromTemplateRequest{\n TemplateID: 7392.96,\n Recipients: []operations.TemplateCreateDocumentFromTemplateRecipientRequest{},\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.templates.use(template_id=7392.96, recipients=[])\n\n # Handle response\n print(res)" } ] } }, "/template/direct/create": { "post": { "operationId": "template-createTemplateDirectLink", "summary": "Create direct link", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Create a direct link for a template", "tags": [ "Template" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "number" }, "directRecipientId": { "type": "number" } }, "required": [ "templateId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "token": { "type": "string" }, "createdAt": { "type": "string" }, "enabled": { "type": "boolean" }, "directTemplateRecipientId": { "type": "number" }, "envelopeId": { "type": "string" }, "templateId": { "type": "number" } }, "required": [ "id", "token", "createdAt", "enabled", "directTemplateRecipientId", "envelopeId", "templateId" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "templates.directLink", "x-speakeasy-name-override": "create", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Templates.DirectLink.Create(ctx, operations.TemplateCreateTemplateDirectLinkRequest{\n TemplateID: 5094.31,\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.templates.direct_link.create(template_id=5094.31)\n\n # Handle response\n print(res)" } ] } }, "/template/direct/delete": { "post": { "operationId": "template-deleteTemplateDirectLink", "summary": "Delete direct link", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Delete a direct link for a template", "tags": [ "Template" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "number" } }, "required": [ "templateId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "templates.directLink", "x-speakeasy-name-override": "delete", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Templates.DirectLink.Delete(ctx, operations.TemplateDeleteTemplateDirectLinkRequest{\n TemplateID: 9950.03,\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.templates.direct_link.delete(template_id=9950.03)\n\n # Handle response\n print(res)" } ] } }, "/template/direct/toggle": { "post": { "operationId": "template-toggleTemplateDirectLink", "summary": "Toggle direct link", "description": "Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Enable or disable a direct link for a template", "tags": [ "Template" ], "security": [ { "apiKey": [] } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "number" }, "enabled": { "type": "boolean" } }, "required": [ "templateId", "enabled" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "token": { "type": "string" }, "createdAt": { "type": "string" }, "enabled": { "type": "boolean" }, "directTemplateRecipientId": { "type": "number" }, "envelopeId": { "type": "string" }, "templateId": { "type": "number" } }, "required": [ "id", "token", "createdAt", "enabled", "directTemplateRecipientId", "envelopeId", "templateId" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-speakeasy-group": "templates.directLink", "x-speakeasy-name-override": "toggle", "x-codeSamples": [ { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Templates.DirectLink.Toggle(ctx, operations.TemplateToggleTemplateDirectLinkRequest{\n TemplateID: 6583.54,\n Enabled: false,\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.templates.direct_link.toggle(template_id=6583.54, enabled=False)\n\n # Handle response\n print(res)" } ] } }, "/embedding/create-presign-token": { "post": { "operationId": "embeddingPresign-createEmbeddingPresignToken", "summary": "Create embedding presign token", "description": "Creates a presign token for embedding operations with configurable expiration time", "tags": [ "Embedding" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expiresIn": { "type": "number", "minimum": 0, "maximum": 10080, "default": 60 }, "scope": { "type": "string" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" }, "expiresAt": { "type": "string" }, "expiresIn": { "type": "number" } }, "required": [ "token", "expiresAt", "expiresIn" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.embedding.embeddingPresignCreateEmbeddingPresignToken({});\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Embedding.EmbeddingPresignCreateEmbeddingPresignToken(ctx, operations.EmbeddingPresignCreateEmbeddingPresignTokenRequest{})\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.embedding.embedding_presign_create_embedding_presign_token(expires_in=60)\n\n # Handle response\n print(res)" } ] } }, "/embedding/verify-presign-token": { "post": { "operationId": "embeddingPresign-verifyEmbeddingPresignToken", "summary": "Verify embedding presign token", "description": "Verifies a presign token for embedding operations and returns the associated API token", "tags": [ "Embedding" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "minLength": 1 }, "scope": { "type": "string" } }, "required": [ "token" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Typescript (SDK)", "source": "import { Documenso } from \"@documenso/sdk-typescript\";\n\nconst documenso = new Documenso({\n apiKey: process.env[\"DOCUMENSO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n const result = await documenso.embedding.embeddingPresignVerifyEmbeddingPresignToken({\n token: \"\",\n });\n\n console.log(result);\n}\n\nrun();" }, { "lang": "go", "label": "Go (SDK)", "source": "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tsdkgo \"github.com/documenso/sdk-go\"\n\t\"github.com/documenso/sdk-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := sdkgo.New(\n sdkgo.WithSecurity(os.Getenv(\"DOCUMENSO_API_KEY\")),\n )\n\n res, err := s.Embedding.EmbeddingPresignVerifyEmbeddingPresignToken(ctx, operations.EmbeddingPresignVerifyEmbeddingPresignTokenRequest{\n Token: \"\",\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}" }, { "lang": "python", "label": "Python (SDK)", "source": "from documenso_sdk import Documenso\nimport os\n\n\nwith Documenso(\n api_key=os.getenv(\"DOCUMENSO_API_KEY\", \"\"),\n) as documenso:\n\n res = documenso.embedding.embedding_presign_verify_embedding_presign_token(token=\"\")\n\n # Handle response\n print(res)" } ] } } }, "components": { "securitySchemes": { "apiKey": { "type": "apiKey", "in": "header", "name": "Authorization" } } }, "security": [ { "apiKey": [] } ], "x-ext-urls": {} }