如何在DocuSign API查询信封时排除已删除项目(Deleted Items)?
解决DocuSign API查询排除已删除信封的问题
可以通过指定文件夹参数过滤掉Deleted Items里的信封,具体操作如下:
先确认Deleted Items文件夹的ID
调用文件夹列表API获取账户内所有文件夹信息:GET /restapi/v2.1/accounts/{{account_id}}/folders从返回结果里找到对应“Deleted Items”的
folderId,默认通常是2,但建议自己查询确认(部分自定义账户可能有差异)。修改原查询请求,添加排除或指定文件夹的参数
有两种可行方式:- 指定要查询的文件夹:用
folder_ids参数列出收件箱、已发送等需要包含的文件夹ID(比如收件箱默认ID是1,已发送是3),示例请求:GET /restapi/v2.1/accounts/{{account_id}}/envelopes/?from_date=2023-01-01&status=created,sent&custom_field=registration_id%3D123456&folder_ids=1,3 - 直接排除Deleted Items文件夹:用
exclude_folder_ids参数填入之前查到的已删除文件夹ID,示例请求:GET /restapi/v2.1/accounts/{{account_id}}/envelopes/?from_date=2023-01-01&status=created,sent&custom_field=registration_id%3D123456&exclude_folder_ids=2
- 指定要查询的文件夹:用
这样就能确保查询结果里不会包含Deleted Items文件夹中的信封了。
内容的提问来源于stack exchange,提问作者Michael
相关产品推荐
相关产品推荐

