Skip to navigation

Create request

View as Markdown
Creates a new request from an intake form. Intake form field values are submitted separately.

Authentication

AuthorizationBearer
Docusign OAuth 2.0 access token

Path parameters

accountIdstringRequiredformat: "uuid"
The ID of the account that owns the request statuses.

Request

This endpoint expects an object.
intake_form_idstringRequiredformat: "uuid"
The intake form to create the request from.
titlestringRequired<=500 characters
The title of the request.
due_datedate or nullOptional
The date the request is due.
intake_form_fieldsobject or nullOptional

Form field values, keyed by the field’s API reference name (componentName, same value as the “id” returned by GET /request-types/{id}/fields). Submit a plain scalar per field, matching its field_type from the fields endpoint (string for Short Text/Text/Date/enum, number for Number and Currency — the currency code itself is fixed by the form and does not need to be supplied). A field with “read_only”: true on the fields endpoint is rejected with a 400 error (code “read_only_field”) if included. A Party (DynamicList) field also reports “read_only”: true, but that reflects only its field type, not a form-author-configured read-only setting, so it can still be set — submit an array of objects, each with exactly one of “id” (an existing party’s UUID) or “name” (a party display name — resolved to an existing party by exact match, or created if none matches), e.g. [{“id”: “11111111-1111-1111-1111-111111111111”}, {“name”: “Acme Corp”}]. If the form author has additionally configured a Party field as read-only, it is rejected like any other read-only field. A DynamicList field that isn’t a Party lookup is rejected (code “unsupported_field_type”). An unrecognized field name is rejected (code “unknown_field”). For Attachment fields, upload the file to DMS yourself first, then submit an object of the form {“documentId”: “<DMS document GUID>”, “fileName”: “Lease Agreement.docx”} as the field’s value. A field omitted from intake_form_fields is set to the value the form author configured as its default, if any — including a read_only field, whose default is its value regardless of what the form’s fields endpoint reports for other fields. A field present with an explicit null is left empty: no value is stored and no default is substituted; if that field is required, the request is rejected with a 400 error (code “invalid_value”). A default for a field hidden by the form’s conditional display rules is not stored.

owner_idstring or nullOptionalformat: "uuid"
The owner of the request. Defaults to the submitter.
submitter_idstring or nullOptionalformat: "uuid"
The submitter of the request. Defaults to the authenticated user.

Response

The request was created.
idstringRead-onlyformat: "uuid"
The unique identifier of the request.
intake_form_idstringformat: "uuid"
The identifier of the intake form the request was created from.
statusstring
The current status of the request.
titlestring
The title of the request.
_actionsobjectOptional
The set of actions available on a request.
due_datedate or nullOptional
The date the request is due.
friendly_idstring or nullOptionalRead-only

A human-readable identifier for the request (e.g. REQ-0042).

metadataobjectOptional
Audit and provenance metadata for a resource.
ownerobjectOptional
A concise reference to a participant, such as the creator of a resource.
request_type_namestring or nullOptionalRead-only
The display name of the request type.
request_urlstring or nullOptionalRead-onlyformat: "uri"
Deep link to the request in the Agreement Desk UI.
submitterobjectOptional
A concise reference to a participant, such as the creator of a resource.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error