Remove Participants Signing requests
/unified/e-signature/signing_requests/remove_participants
Query Parameters
Refer Specifying query parameters in Truto APIs
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns 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.debugreturns the final unified result alongside raw remote fetch information. The response is an envelope containingresult(identical to unified mode output) anddebug(withrequestUrl,requestOptions,data,responseHeaders, and for list operations:nextCursor,isLooping,isEmptyResult,resultCount).debugisnullfor static responses or whentruto_skip_api_call=true.
Defaults to unified.
unifiedunifiedrawnormalizedstreamdebug
Excludes the remote_data attribute from the response.
Validates the request body against this method's request_body_schema before the request is sent to the underlying integration. When a field marked required is missing, Truto responds 400 with the missing field names under truto_error_insight.missing_required_body_fields instead of forwarding the call. Only the fields documented in request_body_schema are checked. A body carrying a non-empty remote_data object is forwarded unchecked, because remote_data is merged into the provider request and may already carry the required values. A field the mapping always supplies through its default body is treated as present, and a field that is only conditionally required is reported under truto_error_insight.conditionally_required_body_fields rather than rejected. Some integrations declare fields required on update that the provider only requires on create; check meta/{method} for the resource before enabling this on update calls. If you sent an Idempotency-Key and the request was rejected, use a fresh key when you retry with a corrected body: the idempotency cache is keyed on the integrated account, path and key only — it ignores the query string and the body — so reusing the key replays the rejection. Defaults to false, which forwards the request as-is.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barRequest Body
Refer Writing data using Unified APIs
The participants of the signing request.
1 supported1 required
The unique identifier of the participant.
The emails of the participant.
1 property
The email address of the participant.
Specifies whether the participant is a signer of the document.
The name of the participant.
The routing order of the participant.
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.
1 supported1 required
The unique identifier of the signing_request.
Response Body
If the signing request is voided or cancelled, the reason is specified here.
1 supported
The collections of the signing request.
1 supported
The unique identifier of the collection.
The name of the collection.
The date and time when the signing request was created.
1 supported
Human readable description of the signing request. This is usually the email body that goes as part of the signing request.
The date and time when the signing request expires.
1 supported
The groups of the signing request.
The unique identifier of the group.
The type of the group.
The unique identifier of the signing request.
1 supported
The date and time when the signing request was last updated.
1 supported
The name of the signing request. This is usually the email subject that goes as part of the signing request.
1 supported
The participants of the signing request.
1 supported
The emails of the participant.
1 property
The email address of the participant.
The unique identifier of the participant.
Specifies whether the participant is a signer of the document.
The name of the participant.
The routing order of the participant.
Raw data returned from the remote API call.
The status of the signing request.
1 supported
The type of the signing request.
1 supported
The date and time when the signing request was last updated.
1 supported
The urls of the signing_request
1 supported
The type of the url
vieweditpublic_view
The url of the signing_request
truto unified e-signature signingrequests \
-m remove_participants \
-a '<integrated_account_id>' \
-o jsonimport Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
// Custom method: remove_participants
const result = await truto.unifiedApi.remove_participants(
'e-signature',
'signingrequests',
{ integrated_account_id: '<integrated_account_id>' }
);
console.log(result);import asyncio
from truto_python_sdk import TrutoApi
truto_api = TrutoApi(token="<your_api_token>")
async def main():
# Custom method: remove_participants
result = await truto_api.unified_api.remove_participants(
"e-signature",
"signingrequests",
{"integrated_account_id": "<integrated_account_id>"}
)
print(result)
asyncio.run(main())curl -X POST 'https://api.truto.one/unified/e-signature/signing_requests/remove_participants?integrated_account_id=<integrated_account_id>' \
-H 'Authorization: Bearer <your_api_token>' \
-H 'Content-Type: application/json' \
-d '{
"signing_request": {},
"participants": [],
"remote_data": {}
}'const integratedAccountId = '<integrated_account_id>';
const body = {
"signing_request": {},
"participants": [],
"remote_data": {}
};
const response = await fetch(`https://api.truto.one/unified/e-signature/signing_requests/remove_participants?integrated_account_id=${integratedAccountId}`, {
method: 'POST',
headers: {
'Authorization': 'Bearer <your_api_token>',
'Content-Type': 'application/json',
},
body: JSON.stringify(body),
});
const data = await response.json();
console.log(data);import requests
url = "https://api.truto.one/unified/e-signature/signing_requests/remove_participants"
headers = {
"Authorization": "Bearer <your_api_token>",
"Content-Type": "application/json",
}
params = {
"integrated_account_id": "<integrated_account_id>"
}
payload = {
"signing_request": {},
"participants": [],
"remote_data": {}
}
response = requests.post(url, headers=headers, params=params, json=payload)
print(response.json())