|
2 | 2 | "swagger": "2.0", |
3 | 3 | "info": { |
4 | 4 | "version": "v2.1", |
5 | | - "title": "Docusign REST API", |
6 | | - "description": "The Docusign REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.", |
| 5 | + "title": "Docusign eSignature REST API", |
| 6 | + "description": "The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.", |
7 | 7 | "termsOfService": "https://www.docusign.com/company/terms-and-conditions/web", |
8 | 8 | "contact": { |
9 | 9 | "name": "Docusign Developer Center", |
|
24 | 24 | "application/json" |
25 | 25 | ], |
26 | 26 | "externalDocs": { |
27 | | - "description": "See the DocuSign REST API Guide for more information.", |
| 27 | + "description": "See the Docusign eSignature REST API Guide for more information.", |
28 | 28 | "url": "https://docs.docusign.com/esign" |
29 | 29 | }, |
30 | 30 | "paths": { |
|
4981 | 4981 | "in": "query", |
4982 | 4982 | "required": false, |
4983 | 4983 | "type": "string", |
4984 | | - "description": "Specifies additional information about the envelope to return. Enter a comma-separated list, such as `tabs,recipients`. Valid values are:\n\n- `custom_fields`: The custom fields associated with the envelope.\n- `documents`: The documents associated with the envelope.\n- `attachments`: The attachments associated with the envelope.\n- `extensions`: The email settings associated with the envelope.\n- `folders`: The folder where the envelope exists.\n- `recipients`: The recipients associated with the envelope.\n- `powerform`: The PowerForms associated with the envelope.\n- `tabs`: The tabs associated with the envelope.\n- `payment_tabs`: The payment tabs associated with the envelope.\n- `workflow`: The workflow definition associated with the envelope.\n" |
| 4984 | + "description": "Specifies additional information about the envelope to return. Enter a comma-separated list, such as `tabs,recipients`. Valid values are:\n\n- `custom_fields`: The custom fields associated with the envelope.\n- `documents`: The documents associated with the envelope.\n- `attachments`: The attachments associated with the envelope.\n- `extensions`: The email settings associated with the envelope.\n- `folders`: The folder where the envelope exists.\n- `recipients`: The recipients associated with the envelope.\n- `powerform`: The PowerForms associated with the envelope.\n- `prefill_tabs`: The pre-filled tabs associated with the envelope.\n- `tabs`: The tabs associated with the envelope.\n- `payment_tabs`: The payment tabs associated with the envelope.\n- `workflow`: The workflow definition associated with the envelope.\n" |
4985 | 4985 | }, |
4986 | 4986 | { |
4987 | 4987 | "name": "include_anchor_tab_locations", |
|
8344 | 8344 | "EnvelopeRecipients" |
8345 | 8345 | ], |
8346 | 8346 | "summary": "Updates recipients in a draft envelope or corrects recipient information for an in-process envelope.", |
8347 | | - "description": "Updates the recipients of a draft envelope or corrects recipient information for an in-process envelope.\n\nIf you send information for a recipient that does not already\nexist in a draft envelope, the recipient is added to the envelope\n(similar to the [EnvelopeRecipients: Create][EnvelopeRecipients-create] method).\n\nYou can also use this method to resend an envelope to a recipient\nby using the `resend_envelope` option.\n\n**Updating Sent Envelopes**\n\nAfter an envelope has been sent, you can edit only the following properties:\n\n- `accessCode`\n- `agentCanEditName`\n- `agentCanEditEmail`\n- `customFields`\n- `deliveryMethod`\n- `documentVisibility`\n- `email` (If you provide an email address in this method, it will be treated as a new email address, even if it is exactly the same as the current address. Do not provide an email address if you do not want a correction email sent.)\n- `emailNotification`\n- `idCheckConfigurationName`\n- `identityVerification`\n- `name`\n- `note`\n- `phoneAuthentication`\n- `recipientType` (For this to work, you must also change the recipient object to match the recipient type.)\n- `requireIdLookup`\n- `routingOrder`\n- `routingOrder`\n- `signingGroupId` (You can change this ID to switch to a different signing group and its corresponding set of recipients.)\n- `smsAuthentication`\n- `suppressEmails`\n- `userName`\n\nIf the recipient has signed,\nbut the envelope is still active,\nthe method will return success,\nbut the `recipientUpdateResults` property\nin the response will include an error\nthat the recipient could not be updated:\n\n```\n{\n \"recipientUpdateResults\": [\n {\n \"recipientId\": \"999\",\n \"errorDetails\": {\n \"errorCode\": \"RECIPIENT_UPDATE_FAILED\",\n \"message\": \"The recipient could not be updated. Recipient not in state that allows correction.\"\n }\n }\n ]\n}\n```\n\nIf the envelope is completed,\nand you try to change a recipient's address,\nthe method will fail with this error:\n\n```\n{\n \"errorCode\": \"ENVELOPE_INVALID_STATUS\",\n \"message\": \"Invalid envelope status. Envelope status is not one of: Created, Sent, Delivered, Correct.\"\n}\n```\n\n**Note:** This method works on recipients only.\nTo add recipient tabs,\nuse methods from the [EnvelopeRecipientTabs][recipientTabs] resource.\nFor example, this request body will add a recipient (`astanton@example.com`)\nbut **NOT** the Sign Here recipient tab.\n\n```json\n{\n \"signers\": [\n {\n \"email\": \"astanton@example.com\",\n \"name\": \"Anne Stanton\",\n \"recipientId\": \"1\",\n// THIS WILL NOT WORK\n \"tabs\": {\n \"signHereTabs\": [\n {\n \"anchorString\": \"below\",\n \"tooltip\": \"please sign here3\"\n },\n . . .\n ]\n }\n }\n ]\n}\n```\n\n\n[EnvelopeRecipients-create]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/create/\n[recipientTabs]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n\n", |
| 8347 | + "description": "Updates the recipients of a draft envelope or corrects recipient information for an in-process envelope.\n\nIf you send information for a recipient that does not already\nexist in a draft envelope, the recipient is added to the envelope\n(similar to the [EnvelopeRecipients: Create][EnvelopeRecipients-create] method).\n\nYou can also use this method to resend an envelope to a recipient\nby using the `resend_envelope` option.\n\n**Updating Sent Envelopes**\n\nAfter an envelope has been sent, you can edit only the following properties:\n\n- `accessCode`\n- `agentCanEditName`\n- `agentCanEditEmail`\n- `customFields`\n- `deliveryMethod`\n- `documentVisibility`\n- `email` (If you provide an email address in this method, it will be treated as a new email address, even if it is exactly the same as the current address. Do not provide an email address if you do not want a correction email sent.)\n- `emailNotification`\n- `idCheckConfigurationName`\n- `identityVerification`\n- `name`\n- `note`\n- `phoneAuthentication`\n- `recipientType` (For this to work, you must also change the recipient object to match the recipient type.)\n- `requireIdLookup`\n- `routingOrder`\n- `signingGroupId` (You can change this ID to switch to a different signing group and its corresponding set of recipients.)\n- `smsAuthentication`\n- `suppressEmails`\n- `userName`\n\nIf the recipient has signed,\nbut the envelope is still active,\nthe method will return success,\nbut the `recipientUpdateResults` property\nin the response will include an error\nthat the recipient could not be updated:\n\n```\n{\n \"recipientUpdateResults\": [\n {\n \"recipientId\": \"999\",\n \"errorDetails\": {\n \"errorCode\": \"RECIPIENT_UPDATE_FAILED\",\n \"message\": \"The recipient could not be updated. Recipient not in state that allows correction.\"\n }\n }\n ]\n}\n```\n\nIf the envelope is completed,\nand you try to change a recipient's address,\nthe method will fail with this error:\n\n```\n{\n \"errorCode\": \"ENVELOPE_INVALID_STATUS\",\n \"message\": \"Invalid envelope status. Envelope status is not one of: Created, Sent, Delivered, Correct.\"\n}\n```\n\n**Note:** This method works on recipients only.\nTo add recipient tabs,\nuse methods from the [EnvelopeRecipientTabs][recipientTabs] resource.\nFor example, this request body will add a recipient (`astanton@example.com`)\nbut **NOT** the Sign Here recipient tab.\n\n```json\n{\n \"signers\": [\n {\n \"email\": \"astanton@example.com\",\n \"name\": \"Anne Stanton\",\n \"recipientId\": \"1\",\n// THIS WILL NOT WORK\n \"tabs\": {\n \"signHereTabs\": [\n {\n \"anchorString\": \"below\",\n \"tooltip\": \"please sign here3\"\n },\n . . .\n ]\n }\n }\n ]\n}\n```\n\n\n[EnvelopeRecipients-create]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/create/\n[recipientTabs]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n\n", |
8348 | 8348 | "operationId": "Recipients_PutRecipients", |
8349 | 8349 | "consumes": [], |
8350 | 8350 | "produces": [], |
|
38102 | 38102 | "type": "object", |
38103 | 38103 | "properties": { |
38104 | 38104 | "docGenDocumentStatus": { |
38105 | | - "description": "The status of the document. This is a read-only property, and not used in [updateEnvelopeDocGenFormFields][docgen update].\nValid values:\n\n- `mergesuceeded`\n- `created`\n- `hassyntaxerror`\n\n[docgen update]: /docs/esign-rest-api/reference/envelopes/documentgeneration/updateenvelopedocgenformfields/\n\n", |
| 38105 | + "description": "The status of the document. This is a read-only property, and not used in [updateEnvelopeDocGenFormFields][docgen update].\nValid values:\n\n- `mergesucceeded`\n- `created`\n- `hassyntaxerror`\n\n[docgen update]: /docs/esign-rest-api/reference/envelopes/documentgeneration/updateenvelopedocgenformfields/\n\n", |
38106 | 38106 | "type": "string" |
38107 | 38107 | }, |
38108 | 38108 | "docGenErrors": { |
|
0 commit comments