Appearance

Update Signing requests ​

Endpoint ​

http
PATCH /unified/e-signature/signing_requests/{id}
Integrations supported
  • DocuSign

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Request Body ​

Refer Writing data using Unified APIs

status
object

The status of the signing request.

References: SigningRequestStatuses → id
Supported in
  • DocuSign
id
string
name
string
cancellation_reason
string

If you are voiding or cancelling a signing request, specify the reason here.

Supported in
  • DocuSign
remote_data
object

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body ​

id
string

The unique identifier of the signing request.

name
string

The name of the signing request. This is usually the email subject that goes as part of the signing request.

description
string

Human readable description of the signing request. This is usually the email body that goes as part of the signing request.

type
string

The type of the signing request.

status
object

The status of the signing request.

References: SigningRequestStatuses → id
id
string
name
string
cancellation_reason
string

If the signing request is voided or cancelled, the reason is specified here.

collections
object[]

The collections of the signing request.

References: Collections → id
id
string

The unique identifier of the collection.

name
string

The name of the collection.

groups
object[]

The groups of the signing request.

References: Groups → id
id
string

The unique identifier of the group.

type
string

The type of the group.

participants
object[]

The participants of the signing request.

id
string

The unique identifier of the participant.

name
string

The name of the participant.

emails
object[]

The emails of the participant.

email
string

The email address of the participant.

is_signer
boolean

Specifies whether the participant is a signer of the document.

routing_order
number

The routing order of the participant.

urls
object[]

The urls of the signing_request

url
string

The url of the signing_request

type
string

The type of the url

All possible enum values:
  • view
  • edit
  • public_view
created_at
string · date-time

The date and time when the signing request was created.

updated_at
string · date-time

The date and time when the signing request was last updated.

last_activity_at
string · date-time

The date and time when the signing request was last updated.

expires_at
string · date-time

The date and time when the signing request expires.

remote_data
object

Raw data returned from the remote API call.