Skip to content

WebForms - v1.1.0-1.0.5 Release #125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 16, 2025
Merged

WebForms - v1.1.0-1.0.5 Release #125

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c56b3c
TIR - Updated webforms.rest.swagger-v1.1.0.json
garg-mudit Jul 16, 2025
f686b95
Update webforms.rest.swagger-v1.1.0.json
garg-mudit Jul 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
168 changes: 158 additions & 10 deletions webforms.rest.swagger-v1.1.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@
"type": "string",
"enum": [
"owned_by_me",
"created_by_me",
"shared_with_me",
"all"
],
"default": "all"
Expand Down Expand Up @@ -578,7 +580,6 @@
"tokenUrl": "https://account-d.docusign.com/oauth/token",
"scopes": {
"webforms_read": "Read web form configuration",
"webforms_write": "Create web form and modify web form configuration",
"webforms_instance_read": "Read instance configuration",
"webforms_instance_write": "Create instance and modify instance configuration"
}
Expand Down Expand Up @@ -654,6 +655,13 @@
"x-ds-definition-name": "LastModifiedDateTime",
"x-ms-summary": "The DateTime when the webform instance is last modified."
},
"SubmittedDateTime": {
"description": "",
"type": "string",
"format": "date-time",
"x-ds-definition-name": "SubmittedDateTime",
"x-ms-summary": ""
},
"IsStandalone": {
"description": "Is the form a standalone form",
"type": "boolean",
Expand Down Expand Up @@ -695,6 +703,19 @@
"x-ds-definition-name": "InstanceStatus",
"x-ms-summary": "The status of the form instance"
},
"InstanceRecipientStatus": {
"type": "string",
"description": "",
"enum": [
"INITIATED",
"IN_PROGRESS",
"SUBMITTED"
],
"example": "SUBMITTED",
"maxLength": 15,
"x-ds-definition-name": "InstanceRecipientStatus",
"x-ms-summary": ""
},
"InstanceSource": {
"type": "string",
"description": "The method by which the form instance is created.\n",
Expand All @@ -710,6 +731,14 @@
"x-ds-definition-name": "InstanceSource",
"x-ms-summary": "The method by which the form instance is created.\n"
},
"RecipientViewId": {
"type": "string",
"description": "",
"format": "uuid",
"example": "00000000-0000-0000-0000-000000000000",
"x-ds-definition-name": "RecipientViewId",
"x-ms-summary": ""
},
"ClientUserId": {
"type": "string",
"description": "A unique identifier for a user that should originate from client's system. This value can be anything your backend system would use to track individual form instances. Examples include employee IDs, email addresses, surrogate key values, etc.",
Expand All @@ -727,7 +756,7 @@
"AuthenticationMethod": {
"type": "string",
"description": "A value that most closely matches the technique your application used to authenticate the recipient / signer.",
"example": "Biometric, Email, HTTPBasicAuth, Kerberos etc",
"example": "Email",
"maxLength": 40,
"enum": [
"Biometric",
Expand Down Expand Up @@ -772,6 +801,61 @@
"x-ds-definition-name": "ReturnUrl",
"x-ms-summary": "The url to which the user is redirected after the signing is completed"
},
"RoleName": {
"description": "",
"type": "string",
"maxLength": 100,
"example": "Applicant",
"x-ds-definition-name": "RoleName",
"x-ms-summary": ""
},
"Name": {
"description": "",
"type": "string",
"maxLength": 100,
"example": "Bob Smith",
"x-ds-definition-name": "Name",
"x-ms-summary": ""
},
"Email": {
"description": "",
"type": "string",
"maxLength": 100,
"example": "bob.smith@docusign.com",
"x-ds-definition-name": "Email",
"x-ms-summary": ""
},
"PhoneNumber": {
"type": "object",
"description": "",
"properties": {
"countryCode": {
"type": "string",
"maxLength": 7,
"example": "1",
"description": ""
},
"nationalNumber": {
"type": "string",
"maxLength": 15,
"example": "4151112222",
"description": ""
}
},
"x-ds-definition-name": "PhoneNumber",
"x-ms-summary": ""
},
"SendOption": {
"type": "string",
"description": "",
"enum": [
"now"
],
"example": "now",
"maxLength": 15,
"x-ds-definition-name": "SendOption",
"x-ms-summary": ""
},
"ExpirationOffset": {
"type": "integer",
"minimum": 1,
Expand Down Expand Up @@ -828,9 +912,6 @@
"CreateInstanceRequestBody": {
"type": "object",
"description": "The request body for the `Instances::createInstance` endpoint.",
"required": [
"clientUserId"
],
"properties": {
"formValues": {
"$ref": "#/definitions/WebFormValues",
Expand Down Expand Up @@ -864,6 +945,36 @@
"$ref": "#/definitions/ExpirationOffset",
"description": "The number of hours after which the web form instance expires. For example, if you want the instance to expire after 5 days, set this property to `120`.\n\nThis property is **optional.** The default value is `720` (30 days)."
},
"sendOption": {
"$ref": "#/definitions/SendOption",
"description": ""
},
"recipients": {
"description": "",
"type": "array",
"items": {
"type": "object",
"required": [
"roleName",
"name",
"email"
],
"properties": {
"roleName": {
"$ref": "#/definitions/RoleName"
},
"name": {
"$ref": "#/definitions/Name"
},
"email": {
"$ref": "#/definitions/Email"
},
"phoneNumber": {
"$ref": "#/definitions/PhoneNumber"
}
}
}
},
"tags": {
"type": "array",
"items": {
Expand Down Expand Up @@ -908,6 +1019,14 @@
"lastModifiedBy": {
"description": "The user who last modified the web form instance.",
"$ref": "#/definitions/WebFormUserInfo"
},
"submittedDateTime": {
"$ref": "#/definitions/SubmittedDateTime",
"description": ""
},
"instanceSource": {
"$ref": "#/definitions/InstanceSource",
"description": ""
}
},
"example": {
Expand Down Expand Up @@ -1000,6 +1119,11 @@
"properties": {
"id": {
"$ref": "#/definitions/EnvelopeId"
},
"createdDateTime": {
"description": "The dateTime when an envelope is created.",
"type": "string",
"format": "date-time"
}
}
}
Expand All @@ -1010,7 +1134,22 @@
},
"formValues": {
"$ref": "#/definitions/WebFormValues",
"description": "Key-value pairs used to prefill fields in the web form instance. The keys correspond to the values of the `publishedComponentNames` object on the `WebForm` (configuration) object.\n\nExample:\n```\n{\n \"Signer_name\": \"Francis Beagle\",\n \"Signer_email\": \"francis@example.com\"\n}\n```"
"description": "Key-value pairs that represent the current values of the fields in the web form instance. The keys correspond to the `componentName` values of the `formContent.components` object on the `WebForm` (configuration) object. See [Form field definitions](/docs/web-forms-api/plan-integration/retrieve-configuration-details/#form-field-definitions) for more information.\n\nSee [Request that retrieves web form instance values](/docs/web-forms-api/plan-integration/retrieve-submitted-values/#request-that-retrieves-web-form-instance-values) for an example of a `formValues` object returned by this request.\n"
},
"recipients": {
"description": "",
"type": "array",
"items": {
"type": "object",
"properties": {
"recipientViewId": {
"$ref": "#/definitions/RecipientViewId"
},
"instanceRecipientStatus": {
"$ref": "#/definitions/InstanceRecipientStatus"
}
}
}
}
},
"x-ds-definition-name": "WebFormInstance",
Expand Down Expand Up @@ -1143,7 +1282,10 @@
"Checkbox_hobbies": [
"singing",
"dancing"
]
],
"ID_card_attachment": {
"documentName": "id_card.pdf"
}
},
"x-ds-definition-name": "WebFormValues",
"x-ms-summary": "Key-value pairs of data used to create a form instance."
Expand Down Expand Up @@ -1178,6 +1320,11 @@
"isPrivateAccess": {
"$ref": "#/definitions/IsPrivateAccess",
"description": "When `true`, a valid instance token is required to access the instance via its URL. "
},
"allowSending": {
"type": "boolean",
"description": "",
"example": true
}
},
"x-ds-definition-name": "WebFormProperties",
Expand Down Expand Up @@ -1216,7 +1363,8 @@
"Number",
"RadioButtonGroup",
"Select",
"TextBox"
"TextBox",
"FileInput"
],
"example": "CheckboxGroup",
"x-ds-definition-name": "WebFormComponentType",
Expand Down Expand Up @@ -1447,7 +1595,7 @@
}
},
"example": {
"source": "template",
"source": "templates",
"owner": {
"userId": "00000000-0000-0000-0000-000000000000",
"userName": "DocuSign User"
Expand Down Expand Up @@ -1596,4 +1744,4 @@
"description": "<ds-inlinemessage>The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact \n[DocuSign Support](https://support.docusign.com/s/?language=en_US) or your account manager to find out whether the Web Forms API is available for your production account plan.</ds-inlinemessage>\n\nMethods for working with web forms."
}
]
}
}